Workbench Scripting Guide

ANSYS, Inc. Release 16.0

Southpointe January 2015
2600 ANSYS Drive
Canonsburg, PA 15317 ANSYS, Inc. is
[email protected] certified to ISO
9001:2008.
http://www.ansys.com
(T) 724-746-3304
(F) 724-514-9494
Copyright and Trademark Information

© 2014-2015 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, 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. 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
Scripting Overview ..................................................................................................................................... 1
Journaling and Scripting Capability Overview ......................................................................................... 1
Journaling ........................................................................................................................................ 1
Recording and Playing a Journal ................................................................................................. 2
Using the Command Window ..................................................................................................... 2
Scripting .......................................................................................................................................... 5
Command Line Execution ........................................................................................................... 5
Scripting and Data-Integrated Applications ...................................................................................... 6
ANSYS Workbench Project and Data Model Concepts .............................................................................. 7
Using Scripting in ANSYS Workbench ...................................................................................................... 15
Object-Based Approach ........................................................................................................................ 15
Units .................................................................................................................................................... 16
File Path Handling in ANSYS Workbench ................................................................................................ 17
Usage Examples ................................................................................................................................... 18
Automatically Update all Projects Affected by a Design Modification ............................................... 18
Interaction with Files in a Project ..................................................................................................... 22
Material Properties and Tabular Data ............................................................................................... 25
Mechanical APDL and Sending Commands to Integrated Applications ............................................. 28
Updating a Workbench Project and Parameters from Excel .............................................................. 31
Set Up, Solve, and Post-Process a Fluids Study Using AIM ................................................................. 34
Set Up, Solve, and Post-Process a Structural Study Using AIM ........................................................... 38
Updating a Workbench Project and Parameters from Excel Using AIM .............................................. 41
Known Issues and Limitations .................................................................................................................. 45
Known Issues and Limitations ............................................................................................................... 45
I. Data Containers ..................................................................................................................................... 47
ACP ...................................................................................................................................................... 49
ACP Setup ...................................................................................................................................... 49
Ansoft ................................................................................................................................................. 51
Ansoft ............................................................................................................................................ 51
Ansoft Feedback Iterator .................................................................................................................... 53
Ansoft Feedback Iterator ................................................................................................................. 53
AQWA .................................................................................................................................................. 57
AQWA Model .................................................................................................................................. 57
AQWA Results ................................................................................................................................. 59
AQWA Setup ................................................................................................................................... 60
AQWA Solution ............................................................................................................................... 62
AUTODYN ............................................................................................................................................ 65
AUTODYN Analysis .......................................................................................................................... 65
AUTODYN Setup ............................................................................................................................. 65
CFD Results ......................................................................................................................................... 69
CFD Results .................................................................................................................................... 69
CFX ...................................................................................................................................................... 73
CFX Setup ...................................................................................................................................... 73
CFX Solution ................................................................................................................................... 76
Design Exploration ............................................................................................................................. 83
DX Direct Optimization ................................................................................................................... 83
DX Evaluation Container ............................................................................................................... 128
DX GDO Design of Experiment ...................................................................................................... 197
DX GDO Response Surface ............................................................................................................ 220
DX Parameters Correlation ............................................................................................................ 254

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. iii
Scripting Guide

DX Six Sigma Analysis ................................................................................................................... 271

Engineering Data .............................................................................................................................. 289
Engineering Data .......................................................................................................................... 289
Engineering Data Curve Fit ........................................................................................................... 323
Engineering Data Favorite Items .................................................................................................... 327
Engineering Data Favorite Library ................................................................................................. 348
External Connection ......................................................................................................................... 375
External Connection ..................................................................................................................... 375
External Data .................................................................................................................................... 377
External Data ................................................................................................................................ 377
External Model Setup ....................................................................................................................... 391
External Model Setup .................................................................................................................... 391
Finite Element Modeler .................................................................................................................... 399
Finite Element Modeler ................................................................................................................. 399
FLUENT .............................................................................................................................................. 409
FLUENT Setup ............................................................................................................................... 409
FLUENT Solution ........................................................................................................................... 422
FLUENT TGridData ........................................................................................................................ 437
Geometry .......................................................................................................................................... 441
Geometry ..................................................................................................................................... 441
Graphics ............................................................................................................................................ 451
Graphics ....................................................................................................................................... 451
ICE ..................................................................................................................................................... 469
ICE ............................................................................................................................................... 469
ICE Setup ...................................................................................................................................... 471
ICEM .................................................................................................................................................. 475
ICEM CFD ..................................................................................................................................... 475
IcePak ................................................................................................................................................ 477
IcePak Setup ................................................................................................................................. 477
IcePak Solution ............................................................................................................................. 478
Mechanical APDL .............................................................................................................................. 481
Mechanical APDL .......................................................................................................................... 481
Mechanical ........................................................................................................................................ 487
Mechanical Enhanced Model ........................................................................................................ 487
Mechanical Model ........................................................................................................................ 488
Mechanical Results ....................................................................................................................... 497
Mechanical Setup ......................................................................................................................... 502
Mechanical Solution ..................................................................................................................... 505
Mesh .................................................................................................................................................. 511
Mesh ............................................................................................................................................ 511
Microsoft Office Excel Analysis ......................................................................................................... 519
Microsoft Office Excel Analysis ...................................................................................................... 519
Parameters ........................................................................................................................................ 527
Parameters ................................................................................................................................... 527
Polyflow ............................................................................................................................................ 537
Polyflow Setup ............................................................................................................................. 537
Polyflow Solution .......................................................................................................................... 541
Project ............................................................................................................................................... 545
Project .......................................................................................................................................... 545
Project File Types .......................................................................................................................... 557
Project Files .................................................................................................................................. 558
Project Messages .......................................................................................................................... 563

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
iv of ANSYS, Inc. and its subsidiaries and affiliates.
 Scripting Guide

Study ................................................................................................................................................. 565

Study ........................................................................................................................................... 565
System Coupling ............................................................................................................................... 855
System Coupling Setup ................................................................................................................. 855
System Coupling Solution ............................................................................................................. 873
TurboSystems ................................................................................................................................... 883
Turbo Geometry ........................................................................................................................... 883
Turbo Mesh .................................................................................................................................. 888
Turbo Setup .................................................................................................................................. 893
Vista AFD Analysis ......................................................................................................................... 922
Vista AFD Design .......................................................................................................................... 938
Vista AFD Meanline ....................................................................................................................... 955
Vista CCD ...................................................................................................................................... 963
Vista CCM ..................................................................................................................................... 991
Vista CPD ...................................................................................................................................... 998
Vista RTD .................................................................................................................................... 1016
Vista TF Setup ............................................................................................................................. 1034
Vista TF Solution ......................................................................................................................... 1041
Units ................................................................................................................................................ 1043
Units .......................................................................................................................................... 1043
Namespaced Commands ........................................................................................................................ 1047
Ansoft .............................................................................................................................................. 1047
EKM .................................................................................................................................................. 1050
EngData ........................................................................................................................................... 1056
Extensions ........................................................................................................................................ 1057
Fluent ............................................................................................................................................... 1059
Graphics ........................................................................................................................................... 1059
Mechanical ....................................................................................................................................... 1062
Meshing ........................................................................................................................................... 1063
Parameters ....................................................................................................................................... 1063
Project .............................................................................................................................................. 1071
Study ................................................................................................................................................ 1107
Data Types .............................................................................................................................................. 1111
Data Types ........................................................................................................................................ 1111
Index ...................................................................................................................................................... 1177

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. v
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
vi of ANSYS, Inc. and its subsidiaries and affiliates.
Scripting Overview
Journaling and Scripting Capability Overview
ANSYS Workbench offers the ability to record the actions you perform via the GUI, which we refer to
as journaling. Journals are recorded as Python-based scripts. You can modify these scripts or create new
ones, which we refer to as scripting. Together, these capabilities allow you to quickly and easily replay
analyses you've already run via recorded journals, as well as to extend functionality, automate repetitive
analyses, and run analyses in batch mode via scripting.

Most actions are journaled. Some examples of actions that are not journaled include:

• GUI-only actions, such as:

– Interrupting a Solve operation

– Running in Compact mode

– Launching help (including Quick Help and Sidebar Help)

– Running the View Solver Output option from VistaTF's Solution cell

• Actions taken in some data-integrated applications; see Scripting and Data-Integrated Applications (p. 6)

• Some graphics scene actions, such as high body and rotation.

Note

For the purposes of this documentation, ANSYS Workbench refers to all applications and
tools running in the Workbench environment, including the Project tab, Parameter Manager,
and ANSYS AIM. Features that apply only to specific applications or tools will be so noted.

Note

Journaling and scripting uses a decimal point as the decimal separator and a comma as the
separator for list items regardless of locale settings. The GUI will display values and lists using
the current locale settings.

Journaling
A journal is a record of all operations that have modified data during your session. Based on your
Preferences setting, a journal of your full session will automatically be saved to the location you specify
(see Setting Journaling Preferences (p. 2)). You can also choose to record part of a session to a journal
file, capturing a specific set of actions. Playing back the journal will recreate the recorded actions exactly.
Journaling and scripting tools (including recording and playback) are available through the File>
Scripting menu in ANSYS Workbench.

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

Journaled sessions can be used to restore work after a crash. Journals are platform independent and
portable, subject to file location consistency between accounts (see File Path Handling in ANSYS
Workbench for details on file path handling within journals and scripts).

Setting Journaling Preferences

You can set journaling preferences such as the default directory where journals will be written and how
long to keep a journal file.

1. In ANSYS Workbench, select Tools > Options > Journals and Logs.

2. Select Record Journal Files to have ANSYS Workbench automatically write journal files.

3. Specify the default location where journal files will be written. This is the location that the file browser
will open in automatically when you choose to begin recording a journal. You will still be able to browse
to a different location before saving a particular journal.

4. Specify the number of days to keep a journal file.

5. Specify how long (in seconds) to pause between each command when running a journal file.

6. Click OK to save your settings.

Recording and Playing a Journal

Follow the steps described below to record a journal and then to playback a journal interactively. To
use the command window, see Using the Command Window (p. 2).

Recording a Journal

1. Launch ANSYS Workbench.

2. Select File > Scripting > Record Journal.

3. Specify the name and location of the journal file and click Save.

4. Use the GUI to work through your analysis as you normally would.

5. Select File > Scripting >Stop Recording Journal.

6. A message appears informing you that you will stop recording. Click OK.

Playing Back a Recorded Journal

1. Select File > Scripting > Run Script File.

2. Select the journal file to be played back and click Open.

3. The previously recorded actions will be performed again.

In ANSYS AIM, you can also play back a journal by selecting the Script icon from the Study panel.

Using the Command Window

The command window allows you to invoke commands, access data entity properties, and invoke data
entity and data container methods interactively, one at a time.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
2 of ANSYS, Inc. and its subsidiaries and affiliates.
 Journaling and Scripting Capability Overview

1. Select File > Scripting > Open Command Window.

2. Enter the commands you want to run, one at a time.

3. As you enter each command, the appropriate action will occur in the ANSYS Workbench database and,
if applicable, in the GUI.

Command Window Usage

While recording a journal, ANSYS Workbench creates a number of variables for the object references
containing the data in your project. For example, consider the following journal snippet:
template1 = GetTemplate(TemplateName="Thermal")
system1 = template1.CreateSystem()

In this journal, template1 and system1 are the variables for the references to the associated data objects.
The variables are used within the journal to access the properties and methods of the objects. These
variables are created and recorded specifically for replaying the journal, and they are not immediately
accessible from within the command window. However, when working in the command window, you
may wish to use these variables. Doing so can aid in manually examining the details of your project or
assist in creating scripts based on the journal. To use these variables, execute the command Import-
JournalVariables() in the command window to make the variable definitions from the currently-
recorded journal available in the command window. You should be aware of the following points when
using the ImportJournalVariables() command:

1. The variable definitions are based on those in the currently-recorded journal. By default, this journal is the
automatically-recorded journal controlled by user preferences (see Setting Journaling Preferences (p. 2)).
If you have manually started a journal recording of part of your session (see Recording a Journal (p. 2)),
the variable definitions will be taken from the manually-recorded journal.

2. If you have any manually-defined variables of the same name as any journal variables, your variables will
be overwritten by the journal variables.

3. Changing the definition of a journal variable in the command window after executing ImportJournal-
Variables() does not affect the definition of the variable in the currently-recorded journal.

4. The ImportJournalVariables() command can be executed multiple times in a session and will
update the variables based on the currently-recorded journal.

Command Window Navigation

The command window uses the Python programming language to interpret and invoke commands or
other operations. In addition, you can use numerous keyboard shortcuts to facilitate your window inter-
action.

Text Cursor Keyboard Keys When typing a command or statement, the following special keys are
available for moving the text cursor:

Key Action
Left Arrow Moves the cursor back one character
Right Arrow Moves the cursor forward one character
Ctrl + Left Arrow Moves the cursor back one word

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

Key Action
Ctrl + Right Moves the cursor forward one word
Arrow
Home Moves the cursor to the beginning of the
line
End Moves the cursor to the end of the line

Copy/Paste Keyboard Keys You can copy text from the command window to the clipboard or paste
text from the clipboard as input to the command window. The following keys allow you to copy and
paste text:

Key Action
Ctrl+C/Ctrl+Insert Copies selected text from the command window to the clipboard. Text copied from
the command window is first selected (highlighted) using the mouse.
Ctrl+V/Shift+Insert Pastes the text found on the clipboard into the input area of the command window.
If multiple lines of text are pasted, the lines must be one or more complete Python
statements.

Command History The command window maintains a history of commands or statements that you
enter so you can easily recall a previously-entered command or statement and invoke it again without
retyping it. You could also make some modifications to it before invoking it again.

The following keys allow you to access the command history:

Key Action
Up Arrow/Page Up Recalls the previously-entered command, and the command before that if the
key is pressed again
Down Arrow/Page Recalls the next command in the history list
Down

Command Completion The command window provides a command-completion (tab-completion)

feature to automatically complete partially-typed variables/commands to save tedious typing.

Type one or more characters and press the Tab key once or multiple times to see the defined variables
and commands that have names beginning with the characters you typed. Entering an object variable
name with the dot (.) and then pressing the Tab key will cycle through the defined properties and
methods for that object. Entering one or more characters after the dot will restrict the completion results
to just those properties and methods that start with those characters.

The following keys allow you to access the command completion:

Key Action
Tab Completes the current text on the command line with any variable, property, command, or
method name that is valid in the current context. Press Tab repeatedly to cycle forward through
possible completions, if available.
Shift+Tab Same as Tab but cycles backwards through possible completions.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
4 of ANSYS, Inc. and its subsidiaries and affiliates.
 Journaling and Scripting Capability Overview

Scripting
A script is a set of instructions to be issued to ANSYS Workbench. The script can be a modified journal,
or it can be a completely new set of instructions that you write directly.

ANSYS Workbench uses an object-based approach; therefore, for scripting, some knowledge of object
oriented programming and the Python language is advantageous. For detailed information on using
Scripting, see Using Scripting in ANSYS Workbench (p. 15).

ANSYS Workbench scripting is based on IronPython 2.6. Before attempting to write or modify ANSYS
Workbench scripts, you should be familiar with using this version of Python.

IronPython is well integrated with the rest of the .NET Framework (on Windows) and Mono CLR (on
Linux) and makes all related libraries easily available to Python programmers while maintaining compat-
ibility with the Python language. For more information on IronPython, see http://ironpython.code-
plex.com/.

IronPython is generally compatible with existing standard Python scripts. However, not all C-based Python
library modules are available under IronPython, as discussed on the IronPython website.

For more information on Python, including a standard language reference, see http://www.python.org/.

For a complete list of our published data containers, namespaced commands, and data types, see the
reference material later in this document. You can also find this guide in a PDF version on www.an-
sys.com. Go to the Customer Portal, and after logging on, select Product Documentation and click the
Workbench tab.

Command Line Execution

ANSYS Workbench can be executed from the operating system command line and accepts a number
of command line arguments to facilitate automation and the replay of scripts. The following command
can be used to run ANSYS Workbench from the command line:
<installation path>/v160/Framework/bin/<platform>/runwb2

<platform> will be one of the following (as applicable to the application or tool you are using):

Win32
Win64
Linux64

For example, to run ANSYS Workbench from the default installation location on a Windows 64-bit system,
the command would be:
C:\Program Files\ANSYS Inc\V160\Framework\bin\win64\runwb2

The following table describes the command line arguments that can be used to control ANSYS Workbench
file operations and execution behavior at start-up.

Argument Operation
-B Run ANSYS Workbench in batch mode. In this mode, the user interface is not displayed
and a console window is opened. The functionality of the console window is the same
as the ANSYS Workbench Command Window.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 5
Scripting Overview

Argument Operation
-R <ANSYS Replay the specified ANSYS Workbench script file on start-up. If specified in conjunction
Workbench with –B, ANSYS Workbench will start in batch mode, execute the specified script, and
script shut down at the completion of script execution.
file>
-I Run ANSYS Workbench in interactive mode. This is typically the default, but if specified
in conjunction with –B, both the user interface and console window are opened.
-X Run ANSYS Workbench interactively and then exit upon completion of script execution.
Typically used in conjunction with –R.
-F <ANSYS Load the specified ANSYS Workbench project file on start-up.
Workbench
project
file>
-E <command> Execute the specified ANSYS Workbench scripting command on start-up. You can issue
multiple commands, separated with a semicolon (;), or specify this argument multiple
times and the commands will be executed in order.

The Console Window The console window is the same as the command window but is present when
running in batch mode to provide a way of working directly with commands outside of the user interface.

Scripting and Data-Integrated Applications

From the Project Schematic, you can interact with applications that are native to ANSYS Workbench
(called workspaces), and you can launch applications that are data-integrated. Native workspaces are
built entirely on the ANSYS Workbench framework and can use all of its services. Examples of native
workspaces include the Project Schematic, Engineering Data, and Design Exploration.

Data-integrated applications are created independently of the ANSYS Workbench framework but have
been extended so they can be driven by the Project Schematic and share key data and parameters with
ANSYS Workbench and ANSYS Workbench-enabled applications. Data-integrated applications include
the Mechanical APDL application, ANSYS Fluent, ANSYS CFX, DesignModeler, and the Mechanical applic-
ation.

The difference between native workspaces and data-integrated applications is an important consideration
for ANSYS Workbench journaling and scripting. All operations that modify the data associated with a
native workspace are journaled and can be fully automated with ANSYS Workbench scripting. For data-
integrated applications, only those operations initiated from the Project Schematic are journaled, e.g.,
system updates and data transfers. Operations performed within data-integrated application are not
necessarily journaled or controlled by ANSYS Workbench scripting. For example, steps to construct
geometry in Mechanical APDL or solution methods in ANSYS Fluent are not journaled.

Although data-integrated applications do not fully support ANSYS Workbench scripting, many of them
have their own native scripting language which is accessible through the ANSYS Workbench scripting
interface (see Table 1: Scripting Support for Data-Integrated Applications (p. 7)). For example, Mechan-
ical APDL is based on the powerful ANSYS Parametric Design Language (APDL), and APDL commands
can be directly incorporated within an ANSYS Workbench script. Use SendCommand to pass native
scripting commands to data-integrated applications.

You can insert SendCommand calls into your ANSYS Workbench scripts to drive data-integrated applic-
ations; however, data-integrated applications do not necessarily record operations in the ANSYS Work-

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
6 of ANSYS, Inc. and its subsidiaries and affiliates.
 ANSYS Workbench Project and Data Model Concepts

bench journal. Most scriptable data-integrated applications have an independent journal where native
commands are recorded.

A Yes in the Supports Scripting with SendCommand column in Table 1: Scripting Support for Data-
Integrated Applications (p. 7) indicates that the data-integrated application can be driven from an
ANSYS Workbench script by manually inserting SendCommand calls.

A Yes in the Supports Journaling with SendCommand column indicates that the data-integrated
application records its operations with SendCommand, and that the state of the application can be
restored from the ANSYS Workbench journal itself. To learn more about SendCommand, see Mechanical
APDL and Sending Commands to Integrated Applications (p. 28) and the detailed description of the
method in the Data Containers section of this guide.

Table 1: Scripting Support for Data-Integrated Applications

Data-Integrated Native Scripting Supports Scripting Supports

Applications Language with SendCommand Journaling with
SendCommand
Mechanical APDL APDL Yes
Mechanical JScript Yes
CFX CCL Yes Yes
Fluent Scheme Yes Yes
Aqwa JScript Yes
Autodyn Not Available
CFD-Post CCL Yes Yes
FE Modeler JScript Yes
DesignModeler JScript Yes
Meshing JScript Yes
Polyflow Not Available
IcePak Not Available
ICEM CFD TCL Yes No

ANSYS Workbench Project and Data Model Concepts

Project Elements
You should understand the following terms and concepts when working with ANSYS Workbench
scripting. The following graphic depicts the relationship between the objects in a project.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 7
Scripting Overview

Project
The project is the full collection of systems, components, data, and their connections that you create to
achieve an overall CAE goal.

System
A system is a collection of components that together provide workflow to achieve an engineering simulation
goal, such as completing a static structural analysis or a steady state fluid flow simulation. Systems may
also contain a single component to complete an analysis sub-task, for example, meshing a geometric as-
sembly.

Component
A component includes a collection of data and a data editor that work together to achieve a CAE-related
task. A system may include several components which together to define a simulation workflow. A data
editor can be an ANSYS Workbench-enabled application like ANSYS Fluent or Mechanical, or a native ANSYS
Workbench workspace like Engineering Data or Design Exploration. In the ANSYS Workbench user interface,
a component is depicted as a cell in the Project Schematic.

In an abstract sense, a component receives data from external or upstream sources, enables you to
edit data local to the container, and then performs operations to produce output data. For example,
a meshing component may receive geometry data from an upstream source, enable you define
meshing attributes, and then generate a mesh for a downstream analysis.

In addition to managing the data and data editor required for a CAE task, a component also provides
common services to control the input and output data from the component. For example, the
component allows its output data to be transferred to other components.

Data Container
A data container includes data unique to an individual component as well as the services to manage and
manipulate it. Although most components have a single data container, they may have more than one.

Services which create, retrieve, or modify a component’s local data are provided by the data con-
tainer, while services to control the transfer of data into and out of the component are provide by
the component.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
8 of ANSYS, Inc. and its subsidiaries and affiliates.
 ANSYS Workbench Project and Data Model Concepts

Data Entity
A data entity is a data structure defined within the data container. A data container often employs several
data entities. A data entity is similar to a class in an object-oriented programming language; it defines
member data (or properties) and methods which can be called to perform operations on the data.

Data Reference
A data reference is a handle to an instantiated data entity. From a data entity definition, an object can be
created, and the data reference provides access to that object. In an ANSYS Workbench journal, data refer-
ences are assigned to variables. The variables are then used to access the properties and methods of the
data entity. Consider the following example:
system = GetSystem(Name="My Analysis")
system.Update()

The first line queries for a previously instantiated System data entity named “My Analysis.” The
GetSystem method returns a data reference to the specified System object and assigns it to the
variable system. Using this variable, the second line calls a method supported by System data
entity called Update. This method updates the state of the system referenced by the variable,
namely “My Analysis.”

Data Container Reference

Similar to data references, a data container reference is a handle to an instantiated data container object.

Study
ANSYS AIM captures three concepts of Workbench under the Study name:

• Study is the system provided by ANSYS AIM within the Project Schematic. Only one Study system is al-
lowed at this time.

• Study is the component provided by ANSYS AIM, which provides a namespace for the top level AIM
methods and queries.

• Study is the container within the ANSYS AIM system that contains all DataObjects that are created as
the user is working within ANSYS AIM. The ANSYS AIM container (or ANSYS AIM database) is managed
using a dependency graph, or a directed acyclic graph (DAG) in computer science terminology. The
graph is established by means of the AssociatedObject argument of the CreateEntity command.

Task
An ANSYS AIM task is associated with a subset of DataObjects that exist within the ANSYS AIM Study con-
tainer. Each task corresponds to a container. The task container contains only a DataObject that references
a single DataObject within the ANSYS AIM container, which is known as the Task Anchor. This anchor is
the root of the dependency graph that defines the subset of DataObjects (i.e., the context) that the task
action will operate within and is a sub-graph of the overall dependency graph.

Task Group
An ANSYS AIM task group is used to group tasks together for the purposes of presentation. Currently, this
can only be used for the Physics Definition and Physics Solution task types. Grouping these tasks is the
default behavior.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 9
Scripting Overview

In this diagram, we have the Study system which holds, for example, four containers.

The first container is the Study container, which contains the dependency graph.

The dependency graph contains seven data objects. These objects are the objects that are created when
the user is working with ANSYS AIM. Examples could be PartMesh, GeometryImportSource, Force, Ref-
erenceFrame, etc.

The other three containers are task containers that each hold only one data object. This data object is
the Task data object and stores a reference to a data object that exists within the dependency graph,
which is known formally as the task anchor. The dotted lines represent these references.

The context or sub-graph concept for Task 1 is illustrated here:

In this diagram, the context for Task 1 is the graph represented by DataObject 2, DataObject 5, and
DataObject 6, where DataObject 2 is the root of the graph, and DataObject 5 and DataObject 6 are the
leaf nodes of the graph. Task 1 will operate only upon the three data objects within this sub-graph and
does not have the ability to change any data objects within the rest of the dependency graph.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
10 of ANSYS, Inc. and its subsidiaries and affiliates.
 ANSYS Workbench Project and Data Model Concepts

Scripting Interface Concepts

Object
An object encapsulates a combination of data and services that act on the data. In the ANSYS Workbench
scripting interface, data entities, data containers, or components are all examples of objects. Access to
these objects is provided by data references and data container references.

Property
A object’s data is referred to as its properties. In the ANSYS Workbench scripting interface, only objects
derived from data entities have properties. A property is defined by its name, type, and value. Property
types include:

• Boolean

• String

• Numerical types (Integer, Real)

• Physical quantities

• Data references and data container references

• Collections of the above types (Lists, Dictionaries)

An object’s properties are accessed by applying the dot operator on the corresponding reference
to that object. In the example below, parameter1 is a data reference to a Parameter object, and
the Expression property of that object is set to 10.
parameter1.Expression = "10"

Method
A method is a command that is bound to a data entity or data container object. Methods can change
property values, create or delete properties, or invoke complex calculations and operations. Methods may
require arguments to further specify the action to be taken, and they may return an object as a result of
that action. Like properties, an object's methods are accessed by applying the dot operator on a corres-
ponding data reference. In the following example, parameter1 is a data reference to a Parameter object,
and the method SetQuantityUnits is called to set the object's units to meters.
parameter1.SetQuantityUnits("m")

To see a list of all methods and queries in a component, execute dir(<component>) from the
Workbench script console.

Argument
An argument is a variable that can be passed to a method when invoked. An argument has a type and
share most of the same types as properties.

ANSYS Workbench methods use 'Named' arguments, where each argument is given a name that is
used to distinguish it from other arguments in the method. Because the arguments are named,
their order is inconsequential.

Arguments can be required or optional. All required arguments must be specified or the method
will fail. Optional arguments may be omitted and typically take a default value.

In the following example, the density property of a material is set to 8500 kg/m3. The named argu-
ments are "Variables" and "Values" which are set to "Density" and "8500 [kg m^-3]}," respectively.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 11
Scripting Overview

property1.SetData(Variables="Density", Values="8500 [kg m^-3]")

Because ANSYS Workbench uses named arguments, the following form of the command is also ac-
ceptable.
property1.SetData(Values="8500 [kg m^-3]", Variables="Density")

Query
A query is a method which typically returns a data or container reference which can then be used to further
interrogate or modify the project. Queries by themselves do not change the state of the project. Like
methods, queries may require specifying arguments.

Namespaced Commands
Namespaced commands are commands that are not bound to a particular object but have been grouped
in a namespace with other commands having similar context. Like methods, commands perform some
action, often require arguments, and may return an object as a result of the action. In the following example,
the Update command is called in the Project namespace to update all components in a project by refreshing
the input data and performing local calculations:
Project.Update()

AssociatedObject
The AssociatedObject command argument creates a directed edge in the ANSYS AIM dependency graph.

In the same diagram from above:

DataObject 6 may have been created by calling:

dataObject6 = study1.CreateEntity(
Type="SomeExampleType",
AssociatedObject=dataObject2)

The AssociatedObject command argument therefore defines the directed edge which is represented
by the arrow between DataObject 2 and DataObject 6.

Templates
ANSYS Workbench uses templates to create the Projects, System, and Components elements described
above. A template is a high-level description of the item to be created, but does not contain specific
detailed data.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
12 of ANSYS, Inc. and its subsidiaries and affiliates.
 ANSYS Workbench Project and Data Model Concepts

Templates are analogous to document templates provided for Microsoft Word. For example, you may
pick a Word report template that contains the formatting, sections, etc., for a type of report you wish
to create. You then create a document from that template and fill out your specific content within that
document to produce the report. Comparably, you may pick a System Template in ANSYS Workbench
that describes the components, data, and relationships needed to execute a particular type of CAE
analysis. You then create a system from that template, enter data, and perform operations within that
system to complete the analysis.

Templates facilitate and automate creation of project elements for a specific purpose. However, these
templates do not preclude you from manually (and flexibly) building up a project from the constituent
elements to achieve the same goal.

Project Template
A project template defines a set of system templates and the connections between them that can be used
to perform a multi-disciplinary CAE analysis task (e.g., Thermal-Stress or One-Way FSI).

The project template can be used to create specific instances of systems and components within
the project (such as the Custom Templates in ANSYS Workbench Toolbox).

System Template
A system template contains the information to create an ANSYS Workbench System designed for a partic-
ular simulation objective. ANSYS Workbench provides system templates for many types of standard analyses,
including static structural, fluid flow, explicit dynamics, steady-state thermal, and others. The Analysis
Systems listed in the ANSYS Workbench Toolbox are all examples of system templates. All analyses per-
formed in ANSYS Workbench begin by referencing a system template.

Component Template
The component template includes the allowed input/output data types, internal data, and key commands
associated with a specific component (e.g., Geometry).

Simulation Process Template

Simulation Process templates in ANSYS AIM automate some common engineering cases. Each template
provides a simulation process with typical default settings for geometry, mesh, physics and results.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 13
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
14 of ANSYS, Inc. and its subsidiaries and affiliates.
Using Scripting in ANSYS Workbench
Object-Based Approach
ANSYS Workbench scripting follows an object-based approach, where interaction with data is defined
in terms of objects. Objects have properties that can be used to get or set data values, and methods
that use or modify the data. In terms of the ANSYS Workbench concepts described in ANSYS Workbench
Project and Data Model Concepts (p. 7), objects are references to data entities in the data model, and
the methods are commands and queries which operate on those entities.

For example, a Parameter is a data entity that has properties such as description, value, and expression,
and has methods that operate on the parameter to (for example) delete it or determine which other
parts of the data model are associated with the parameter.

ANSYS Workbench objects fall into two general categories: data containers and data entities. The basic
process for operating on these objects is:

1. Query for either a data container or data entity objects. Queries are implemented as methods on both
data container and data entity objects, and they most often start with Get (e.g., GetFiles, GetSystem,
GetComponent). These methods return references to objects that are assigned to variables. The variables
can then be used to access object properties and methods. To illustrate this process, consider the Design
of Experiments (DOE) data container that includes a data entity for the DOE model, which in turn contains
a data entity for the input parameters. To query the input parameter object, first query the DOE model
from the data container, and then query the input parameter from the DOE model:
DOEModel = DOEDataContainer.GetModel()
InputParameter = DOEModel.GetParameter(Name="P1")

In most instances, the variable for a data reference will be reused later in the journal or script so
that queries do not need to be re-executed. However, there are some instances (e.g., System
Coupling Variables), where re-executing the query can clarify the context that is used to access the
object. In those situations, journal variables are not reused and queries are generated each time an
object is referenced.

2. Interrogate and modify object properties. If the query returns a reference to a data entity, you can inter-
rogate its properties and modify those that are not identified as “Read-Only” in the Reference section of
this guide. Properties are accessed by appending a dot and the property name to the variable assigned to
the object reference. For example, once a reference to an input parameter is obtained, you can modify its
classification (or Nature Property) to reflect that it is a continuous or discrete parameter.
inputParameter.Nature = "NatureContinuous"

3. Call methods on objects. In addition to properties, most objects provide methods that operate on internal
data. To call a method on an object, append a dot, the method name, and a comma-separated argument
list in closed parentheses. A method's required and optional arguments are also documented in the Reference
section of this guide. Continuing the input parameter example, you can specify a restricted set of Manufac-
turable Values for a parameter by calling the AddLevels method on the input parameter object and by
constructing a list of values and assigning it to the Levels argument.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 15
Using Scripting in ANSYS Workbench

inputParameter.AddLevels( Levels=["65", "70", "75", "80"])

Typical examples are provided in Usage Examples (p. 18). These examples demonstrate how to query
objects and how to invoke methods on those objects for the desired result. Use the Reference section
at the end of this document for a complete list of all available data container objects, and the data
entities, methods, properties, and arguments associated with each.

Units
Specifying Quantities Without Units
Many properties and variable values in ANSYS Workbench represent physical quantities, which include
both a value and a unit in their definition (see Expressions, Quantities, and Units in the Workbench User's
Guide). The assignments of these quantities are journaled using a “Value [Unit]” string syntax. This
method ensures that all available information is recorded in the journal. However, strings may be incon-
venient to work with when writing or modifying scripts that assign quantities.

As a convenience, ANSYS Workbench allows the assignment of a quantity using just the numeric value.
When units are omitted, the unit is assumed to be the unit for that quantity in the current project unit
system. Although this method is more convenient, you must ensure that the value being supplied is
consistent with the current units.

Setting an Entity Property When setting an entity property that refers to a quantity, the property
assignment can be done as a numeric value, and the units will be taken from the project unit system.
For example, after setting the Inlet Mass Flow in a VistaTF setup, the following would be recorded in
the journal:
vistaTFSetup1 = setup1.GetSetupEntity()
vistaTFSetup1.MassFlow = "0.5 [kg s^-1]"

When entering this command or writing script, you can use a direct numeric value:
vistaTFSetup1 = setup1.GetSetupEntity()
SetProjectUnitSystem(UnitSystemName="SI")
vistaTFSetup1.MassFlow = "0.3 [lbm s^-1]" # Units explicitly provided
print vistaTFSetup1.MassFlow
>>> 0.3 [lbm s^-1]
vistaTFSetup1.MassFlow = 0.3 # Units are taken from the project unit system
print vistaTFSetup1.MassFlow
>>> 0.3 [kg s^-1]

Setting Quantity in Variable Data Tables The same principles apply when setting variables in Ma-
terial Property data tables (used primarily in Engineering Data). For example, after selecting a material
and changing the Density to 9000 [kg m^-3], the following would be recorded in the journal:
material1= eda1.GetMaterial(Name=”Structural Steel”)
materialProperty1= material1.GetProperty(Name=”Density”)
materialProperty1.SetData(
SheetName="Density",
Variables=["Density"],
Values=[["9000 [kg m^-3]"]])

When writing a script, for convenience, you can omit the units, and they will be taken from the current
project unit system. You can also omit the list brackets because only single values are being specified.
A condensed version of the above command that is valid when playing back a script is:
material1= eda1.GetMaterial(Name=”Structural Steel”)
materialProperty1= material1.GetProperty(Name=”Density”)
materialProperty1.SetData(

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
16 of ANSYS, Inc. and its subsidiaries and affiliates.
 File Path Handling in ANSYS Workbench

Variables="Density",
Values=9000)

A more complex example showing the creation of a temperature-dependant property using a script is
given below:
# Temperatures in degrees Fahrenheit
temperatures = [200,400,600,800,1000]
# Coefficient of Thermal Expansion in F^-1
alphas = [6.3e-6, 7.0e-6, 7.46e-6, 7.8e-6, 8.04 e-4]

# Change to an appropriate unit system

#(US Customary, which has an internal tag of "BIN_STANDARD")
SetProjectUnitSystem(UnitSystemName="BIN_STANDARD")

# Create a new instance of engineering data and

# access the Coefficient of Thermal Expansion property of Structural Steel
EDAtemplate = GetTemplate(TemplateName="EngData")
system = EDAtemplate.CreateSystem()
eda = system.GetContainer(ComponentName="Engineering Data")
steel = eda.GetMaterial(Name="Structural Steel")
alpha = steel.GetProperty(Name="Coefficient of Thermal Expansion")

# Set the property data according to the provided data

alpha.SetData(Variables=["Tempertature","Coefficient of Thermal Expansion"],
Values = [temperatures, alphas])

File Path Handling in ANSYS Workbench

ANSYS Workbench uses specific conventions for file or directory paths that are recorded to an ANSYS
Workbench journal, thus improving the portability of these paths between operating systems and user
directories.

Handling Slashes as File Path Separators

ANSYS Workbench uses the following conventions when a forward slash or a backslash is used as a
path separator in a journal or script:

1. When a journal is written, all backslashes that occur in command arguments representing a path are con-
verted to forward slashes.

2. When a command argument containing a path is read, all slashes are internally converted to the current
platform-appropriate slash.

Handling of Absolute/Relative Paths

To ensure a robust recording and playback of scripts and journals, ANSYS Workbench always records
file and directory paths using a full (absolute) path. However, to facilitate portability of journals to dif-
ferent locations on a file system, a User Path Root is used to dynamically record and construct the ab-
solute path.

The following conventions and capabilities are used with the User Path Root.

1. The default value of the User Path Root is taken from the Default Folder for Permanent Files preference.
Changing this preference will take effect in your next session.

2. When a path is recorded to the journal and the start of the path matches the User Path Root, then the path
is recorded using AbsUserPathName("<relative path name>"). This function constructs an ab-
solute path based on the supplied relative path and the current User Path Root.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 17
Using Scripting in ANSYS Workbench

3. You can access or change the current value of User Path Root within a script using the following commands:

• pathRoot = GetUserPathRoot()

• SetUserPathRoot(DirectoryPath=”<new path root>”)

SetUserPathRoot does not change the Default Folder for Permanent Files preference, but simply
overrides the path root setting in the current session.

Example
If the current value of the User Path Root is C:\Users\myUser\Projects, then the command:
Open(FilePath=r"C:\Users\myUser\Projects\proj1.wbpj")

would be journaled as:

Open(FilePath=AbsUserPathName("proj1.wbpj"))

You can override the current User Path Root to control the base location of files in your script:
SetUserPathRoot(DirectoryPath = “C:/Users/myUser1/Projects”)
Open(FilePath=AbsUserPathName("proj1.wbpj")) # Read project from first location
SetUserPathRoot(DirectoryPath = “C:/Users/myUser2/Projects”)
Open(FilePath=AbsUserPathName("proj1.wbpj")) # Read project from second location

Usage Examples
Several examples are provided here to demonstrate some typical scripting uses. All of the files used by
these examples are located in <installpath>\v160\commonfiles\examples\Script-
ing\ScriptingGuideExamples.zip. To use these example files, unzip them into the My Docu-
ments directory. All necessary subdirectories will be created, allowing these sample journals to run
correctly.
Automatically Update all Projects Affected by a Design Modification
Interaction with Files in a Project
Material Properties and Tabular Data
Mechanical APDL and Sending Commands to Integrated Applications
Updating a Workbench Project and Parameters from Excel
Set Up, Solve, and Post-Process a Fluids Study Using AIM
Set Up, Solve, and Post-Process a Structural Study Using AIM
Updating a Workbench Project and Parameters from Excel Using AIM

Automatically Update all Projects Affected by a Design Modification

You have performed a set of analyses on a design with an initial geometry file. These analyses have
been saved as a number of different ANSYS Workbench projects. The design has been modified, and
you have been provided with a new geometry file that represents the updated design. After you extract
the ScriptingGuideExamples.zip file, you will find the files for this example in the
Design_Modification directory.

To automate the update of all affected projects, you would like to write a script that does the following:

1. Finds all ANSYS Workbench projects within a specified directory.

2. For each project that has been found:

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
18 of ANSYS, Inc. and its subsidiaries and affiliates.
 Usage Examples

• Replaces the original geometry with the new geometry file in any system in the project.

• Updates the project and reports any errors from the update.

• If the update was successful, reports the values of key output parameters under the modified geometry.

• Saves the modified project with the new geometry file to a new directory.

Although the analysis specifics are secondary for the purposes of this example, we will use a CFD ana-
lysis of a blood mixing device. This device attempts to maximize mixing of two blood streams while
minimizing flow vorticity (which is an indicator of blood damage potential). Three projects involving a
coarse mesh model, a fine mesh model, and an asymmetric flow condition were created. The parameters
of interest are pressure drop, average and maximum vorticity, and mixing factor of blood stream 1 at
the exit.

Figure 1: Mixing in base geometry

Figure 2: Mixing in modified geometry

Workbench Script The script for this example follows. Each line is numbered for reference in the
discussion that follows.
1 # import the 'os' module, which provides a portable way of using operating system dependent functionality
2 import os
3
4 # Helper function to write parameters to the log file
5 def writeParams(logFile):
6 for param in Parameters.GetAllParameters():
7 prmString = " " + param.Name + ": " + param.DisplayText + " = " + param.Value.ToString()
8 logFile.write(prmString + "\n")
9 logFile.flush()
10
11 workDir = "ScriptingGuideExamples/Design_Modification/"
12
13 # Define the original and target directories
14 origDir = AbsUserPathName(workDir + "Original")
15 newDir = AbsUserPathName(workDir + "Modified")
16
17 # Define new geometry file

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 19
Using Scripting in ANSYS Workbench

18 newGeom = AbsUserPathName(workDir + "Geometry/bloodMix2.agdb")

19
20 # Open a log file to record script progress
21 logFile = open(AbsUserPathName(workDir + "GeometryReplace.log"),"w")
22
23 # Create the new directory if necessary
24 if not os.path.exists(newDir):
25 os.makedirs(newDir)
26
27 # Find all the projects in the original directory
28 projList = []
29 for fileName in os.listdir(origDir):
30 if fileName.endswith(".wbpj"):
31 projList.append(fileName)
32
33 # Process each project one at a time
34 for projFile in projList:
35
36 # Open the project into Workbench and clear any starting messages
37 projPath = os.path.join(origDir, projFile)
38 logFile.write("Processing project in " + projPath + "\n")
39 Open(FilePath=projPath)
40 ClearMessages()
41
42 # Output project parameter values before update
43 logFile.write("Parameter values in original project:\n")
44 writeParams(logFile)
45
46 # Walk through each system in the project and replace the geometry file (if there is a geometry Component)
47 for system in GetAllSystems():
48 try:
49 geometry = system.GetContainer(ComponentName="Geometry")
50 except:
51 logFile.write("No geometry to replace in system " + system.DisplayText + "\n")
52 else:
53 geometry.SetFile(FilePath=newGeom)
54
55 # Update the project
56 try:
57 Update()
58 except:
59 logFile.write("update failed")
60
61 # If the project has been successfully updated, write out the new parameter values
62 # If not, write any project messages
63 if IsProjectUpToDate():
64 logFile.write("Parameter values in revised project:\n")
65 writeParams(logFile)
66 else:
67 logFile.write("ERROR: Project not successfully updated. The following messages were found:\n")
68 for msg in GetMessages():
69 msgString = " " + msg.DateTimeStamp.ToString() + " " + msg.MessageType + ": " + msg.Summary + "\n"
70 logFile.write(msgString + "\n")
71
72 # In any case, save the modified project to the new directory
73 projPath = os.path.join(newDir, projFile)
74 Save(FilePath=projPath)
75
76 logFile.write("\n")
77 # End of project loop
78
76 logFile.close()
79

Log File The log file generated by the above script should look like the following:
Processing project in C:\Users\neUser\Demo/ScriptExample1/Original/AsymmetricFlow.wbpj
Parameter values in original project:
P1: PressureDropCoeff = 34.2088
P2: mixing = 0.217835
P5: maxVorticity = 3939.22 [s^-1]
P4: aveVorticity = 27.4697 [s^-1]

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
20 of ANSYS, Inc. and its subsidiaries and affiliates.
 Usage Examples

Parameter values in revised project:

P1: PressureDropCoeff = 34.0394
P2: mixing = 0.276673
P5: maxVorticity = 3939.22 [s^-1]
P4: aveVorticity = 27.4034 [s^-1]

Processing project in C:\Users\neUser\Demo/ScriptExample1/Original/BaseAnalysis.wbpj

Parameter values in original project:
P1: PressureDropCoeff = 30.04
P2: mixing = 0.248514
P5: maxVorticity = 3939.22 [s^-1]
P4: aveVorticity = 36.8447 [s^-1]
Parameter values in revised project:
P1: PressureDropCoeff = 30.3782
P2: mixing = 0.288321
P5: maxVorticity = 3939.22 [s^-1]
P4: aveVorticity = 36.6682 [s^-1]

Processing project in C:\Users\neUser\Demo/ScriptExample1/Original/FineAnalysis.wbpj

Parameter values in original project:
P1: PressureDropCoeff = 29.0038
P2: mixing = 0.266388
P5: maxVorticity = 3939.22 [s^-1]
P4: aveVorticity = 29.2073 [s^-1]
Parameter values in revised project:
P1: PressureDropCoeff = 30.7209
P2: mixing = 0.295078
P5: maxVorticity = 3939.22 [s^-1]
P4: aveVorticity = 37.5408 [s^-1]

Discussion This example demonstrates a number of the typical programming constructs and ANSYS
Workbench functionality that will be employed in the creation of scripts. The following discussion refers
to the specified line numbers of the example script to illustrate some of these concepts and constructs.

Lines 1-2
The import keyword is used to include Python modules that enhance functionality available within the
script. This ‘os’ module used in this script provides capabilities for interacting with operating system services.
Refer to the Python Standard Library documentation for details on all available modules.

Lines 4-9
A common pattern is to encapsulate repeated operations in Python function definitions and then call these
functions later in the script. Because the script is processed sequentially, the function must be defined
before it is used. In this example, we define a function writeParams() to loop through all the parameters
in the current project and write information to a provided file object. When concatenating data into a
string for output, all non-String data types must first be explicitly converted to their string representation
using the str(<data>) function or .ToString() method.

Lines 11-18
We recommend that you use the AbsUserPathName function when working with directory or file paths
to promote portability of the path between user accounts and operating systems. See File Path Handling
in ANSYS Workbench (p. 17) for further details.

Lines 20-21
Standard Python functionality is used to open and write output to a log file throughout this script.

Lines 23-31
This section also employs standard Python to loop through all file names in a directory. All those file names
that end with the .wbpj extension are added to a list of project files for further processing.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 21
Using Scripting in ANSYS Workbench

Lines 33-40
The script now processes each project in turn. At the beginning of the loop, the full path to the project
file is generated from the provided directory name and project file name in a platform-independent
manner using Python’s os.path.join function. The project is then opened and messages are cleared
so that later message processing will focus on new messages generated during the update. Note that the
Python is case sensitive. The Open command is part of the ANSYS Workbench Project namespace and is
used to open an ANSYS Workbench project, while the open command is provide by Python and is used
to open any file and create a Python file object.

Lines 42-44
The writeParams function defined earlier in the script is used to record parameter values to the log file
before project modification.

Lines 46-47
The GetAllSystems() query is used to provide references to all systems in the project.

Lines 48-53
Since we are specifically interested in Geometry components, we use the system’s GetContainer()
query to try to get a reference to the Geometry data. A Python try/except/else construct is used to handle
the success or failure of the query.

An alternate approach here would be to walk through each component in the system, and then
use information about the component to decide which to process. That approach is demonstrated
in a subsequent example.

Lines 55-59
An ANSYS Workbench project update is used to recompute all aspects of the project affected by the geo-
metry change. This step is the most computationally expensive part of the script. A Python try/except
construct is used to handle the success or failure of the update and prevent a premature exit of the script.

Lines 61-70
After the update operation has completed, we check if the whole project has been successfully updated.
If the project update was successful, we call the writeParams function again to output updated para-
meter information to the log file. If the update was not successful, we record any project messages that
were generated during the update.

Lines 66-70
Similar to the method we used to process parameters, we loop through all messages in the project and
write key information about each message to the log file.

Lines 72-77
A file path for the project within the desired directory for the modified projects is generated, and the ANSYS
Workbench Save command is called to save the modified project. After saving, the loop repeats for the
next project in the list.

Interaction with Files in a Project

In this example, we will look at how you can interact and query specific files that are associated with
components in a project. In this example, you wish to know how and where a specific geometry file
has been used within any ANSYS Workbench project that you have within your directory. After you
extract the ScriptingGuideExamples.zip file, you will find the files for this example in the
Project_File_Search directory.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
22 of ANSYS, Inc. and its subsidiaries and affiliates.
 Usage Examples

To automate this search, we will write a script that performs the operations described below. Two dif-
ferent methods that accomplish the same task are demonstrated to illustrate different approaches to
project and file navigation.

1. Starting from a given location, recursively search through all subdirectories to find any ANSYS Workbench
projects.

2. For each project, looks for a specified geometry file in using one of two methods:

a. Get a flat list of all files in the project, and look for the desired filename.

b. Walk through all systems and their components, and query each component to get the list of files re-
gistered to it. Then look if the component is using a file of the specified name. This method is a more
involved but provides more detailed information (e.g., the specific system/component using the file)
and gives access to the ANSYS Workbench FileReference to provide detailed information like file size
and last modification time.

Workbench Script The script for this example follows. Each line is numbered for reference in the
discussion that follows.
1 # import the 'os' module, which provides a portable way of using operating system dependent functionality
2 import os
3
4 # A helper function to find all Workbench projects within a specified directory and add them to a list.
5 # This recursivly calls itself to process subdirectories.
6 def findProjectFiles(searchDir, fileList):
7 print "Searching in %s" % searchDir
8 for dirEntry in os.listdir(searchDir):
9 fullName = os.path.join(searchDir,dirEntry)
10 if dirEntry.endswith(".wbpj"):
11 # Store the full path to the project file
12 projList.append(fullName)
13 if os.path.isdir(fullName):
14 findProjectFiles(fullName, fileList)
15
16
17 # Define starting directory to find project files.
18 # Here we'll look everywhere within the user's project path root directory.
19 searchDir = AbsUserPathName("ScriptingGuideExamples")
20
21 # Define file name of interest
22 targetFile = "bloodMix1.agdb"
23
24 # Recursively find all WB2 projects within the search directory
25 projList = []
26 findProjectFiles(searchDir, projList)
27
28 # Open a log file to record script progress
29 logFile = open(AbsUserPathName("ScriptingGuideExamples/Project_File_Search/FindFileInProjects.log"),"w")
30
31 for projFile in projList:
32 try:
33 Open(FilePath=projFile)
34 except Exception as ex:
35 logFile.write("Error opening %s, %s\n" % (projFile, ex))
36 continue
37
38 # Method 1: Search the list of all project files.
39 # This method is simpler, but not as much file information is readily available
40 for fileName in GetAllFiles():
41 if fileName.find(targetFile)> -1:
42 logFile.write("--\n")
43 fileStr = "File %s found in project %s\n"
44 logFile.write(fileStr % (fileName, projFile))
45 logFile.flush()
46

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 23
Using Scripting in ANSYS Workbench

47 # Method 2: Walk through the systems and components, to find any that are using the file.
48 # This method is more complex, but provides detailed information through systems,
49 # components and file references. It's also a useful example of general
50 # System & Component navigation.
51
52 # Loop over all systems in the project
53 for system in GetAllSystems():
54 # Loop over the all components in the system
55 for component in system.Components:
56 container = component.DataContainer
57 # Loop over all file data references associated with the container for the component
58 for compFile in container.GetFiles():
59 if compFile.FileName.find(targetFile) > -1:
60 logFile.write("--\n")
61 sysStr = "Target file found in component %s of system named %s in %s. Details:\n"
62 fileStr = " %s, Size %s bytes, Modified %s\n"
63 logFile.write(sysStr % (component.DisplayText, system.DisplayText, projFile))
64 logFile.write(fileStr % (compFile.Location, compFile.Size, compFile.LastModifiedTime))
65 logFile.flush()
66
67 logFile.close()
68

Log File The log file generated by the above script should look like the following:
--
Target file found in component Geometry of system named Static Structural in
C:\Users\neUser\DemoProjects\pipe1.wbpj. Details:
E:\data\Models\pipe_demo\pipe.x_t, Size 6934 bytes, Modified 06/07/2009 11:50:53 AM
--
File E:\data\Models\pipe_demo\pipe.x_t found in project C:\Users\neUser\DemoProjects\pipe1.wbpj
--
Target file found in component Geometry of system named Static Structural in
C:\Users\neUser\Working\pipeDemo.wbpj. Details:
E:\data\Models\pipe_demo\pipe.x_t, Size 6934 bytes, Modified 06/07/2009 11:50:53 AM
--
File E:\data\Models\pipe_demo\pipe.x_t found in project C:\Users\neUser\Working\pipeDemo.wbpj

Discussion This example demonstrates how to navigate through systems and components in a project,
as well as useful queries and data entities for working with files. The following discussion refers to the
specified line numbers of the example script to illustrate some of these concepts and constructs. Dis-
cussion points from earlier examples will not be repeated here.

Lines 4-14
This function finds all project files within a specified directory. The Python os.listdir function returns
all file and directory names in the specified location. If the name ends with .wbpj, ANSYS Workbench
stores the full path to a list of projects. If the name is a directory, ANSYS Workbench recursively calls the
function to search the subdirectory.

Lines 32-36
Here, the script demonstrates exception handling to catch any errors that result from opening the project
file and report the error to the log file. The continue statement skips to the next entry in the project file
loop.

Lines 38-45
This method uses the GetAllFiles() query to get a flat list of all files used in the project and looks at
each entry to see if contains the target file name. If so, we record the full path to the target file and the
project file to the log.

Line 53
The GetAllSystems() query is used to loop over all systems in the project.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
24 of ANSYS, Inc. and its subsidiaries and affiliates.
 Usage Examples

Line 55
The Components property in the system is accessed to loop over the set of components in the system.

Line 56
The DataContainer property is used to access the data within the component.

Line 58
The GetFiles() method on a container is used to return a list of FileReferences that have been associated
to that container.

Lines 59-65
We look at the FileName property of each FileReference to see if it contains the target file name. If so,
other properties of the FileReference, System and Component are used to record information about the
file and its location within the project to the log file.

Material Properties and Tabular Data

This example demonstrates scripting interaction with Engineering Data to access, create, and modify
material property data. In this example, you have experimental total strain/stress data in a text file that
you wish to use to define Multilinear Isotropic Hardening property data for a material. After you extract
the ScriptingGuideExamples.zip file, you will find the files for this example in the Materi-
al_Tabular_Data directory.

As an additional consideration, Multilinear Isotropic Hardening property data in Engineering Data is

defined in terms of plastic strain. The script must first convert the total strain data to plastic strain, using
the relationship:

Plastic Strain = Total Strain – Stress/Young’s Modulus

The above consideration will be used to demonstrate calculations based on physical quantities and
units.

To automate property creation, we will write a script that performs the operations described below:

1. Create a system for a Static Structural analysis, and access the data container for Engineering Data.

2. Load material data for Polyethylene. By default, this material does not include property data for Multilinear
Isotropic Hardening.

3. Read experimental data from a text file, and generate lists of data for the necessary variables (converting
Total Strain to Plastic Strain)

4. Create the Multilinear Isotropic Hardening property within Polyethylene and set its data table.

Sample Data File The sample data file to be used in this example follows:
#
# Stress Stain Data for the Material Properties scripting example.
#
# The data is Total Strain (in m m^-1), Stress (in MPa)
#
7.33E-02, 80.6
1.80E-01, 88.0
6.30E-01, 142.5
7.53E-01, 168.0
8.70E-01, 187.0

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 25
Using Scripting in ANSYS Workbench

Workbench Script The script for this example follows. Each line is numbered for reference in the
discussion that follows.
1 workDir = "ScriptingGuideExamples\Material_Tabular_Data/"
2
3 # Create an Engineering Data system and access its data container
4 template1 = GetTemplate(
5 TemplateName="Static Structural",
6 Solver="ANSYS")
7 system1 = template1.CreateSystem()
8 engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
9
10 # Import Polyethylene
11 poly = engineeringData1.ImportMaterial(
12 Name="Polyethylene",
13 Source="General_Materials.xml")
14
15 # Initialize lists for variable values
16 temperature = []
17 strain = []
18 stress = []
19
20 # Get the value of Young's Modulus for use in the Total/Plastic strain calculation.
21 # Material Property data is always returned as a Quantity.
22 elasticity = poly.GetProperty(Name="Elasticity")
23 E = elasticity.GetData(Variables="Young's Modulus")
24
25 # Read the data file and create lists for Temperature, Strain and Stress values
26 # We must convert Total Strain in the data file into Plastic Strain
27 fileName = AbsUserPathName(workDir + "StressStrainData.txt")
28 dataFile = open(fileName,"r")
29 for line in dataFile:
30 # Skip comment lines
31 if line.startswith("#"):
32 continue
33
34 # Split at the comma to get strain, stress
35 (thisStrain, thisStress) = line.split(",")
36
37 # Convert the data into Quantities with Units.
38 thisStrain = Quantity(float(thisStrain),"m m^-1")
39 thisStress = Quantity(float(thisStress),"MPa")
40
41 # Append data to the variable lists (converting total strain to plastic strain)
42 temperature.append(0)
43 calcStrain = thisStrain - thisStress/E
44 if calcStrain.Value < 1e-4:
45 calcStrain = Quantity(0.0,"m m^-1")
46 strain.append(calcStrain)
47 stress.append(thisStress)
48
49 # Create the Multilinear Isotropic Hardening property and set the data for it
50 miso = poly.CreateProperty(
51 Name="Isotropic Hardening",
52 Definition="Multilinear")
53 miso.SetData(
54 SheetName="Isotropic Hardening",
55 SheetQualifiers={"Definition Method": "Multilinear"},
56 Variables = ["Temperature","Plastic Strain","Stress"],
57 Values = [temperature, strain, stress])
58
59 # Save the project
60 Save(
61 FilePath=AbsUserPathName(workDir + "TabularData.wbpj"),
62 Overwrite=True)

Discussion This example demonstrates interaction with Engineering Data to get, create, and set
material properties, as well as calculations involving quantities and units. The following discussion refers

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
26 of ANSYS, Inc. and its subsidiaries and affiliates.
 Usage Examples

to the specified line numbers of the example script to illustrate some of these concepts and constructs.
Discussion points from earlier examples will not be repeated here.

Lines 1-13
To set the project up to work with Polyethylene, we create a new Static Structural system, access its Engin-
eering Data container, and load material data from the General Materials library.

Lines 15-18
Interaction with tabular data is done in terms of the variables that make up the data table. Each variable
represents a column in the table, with a list of data for the variable. Here we initialize three lists for temper-
ature, strain and stress data. Multilinear Isotropic Hardening property data can be temperature-dependent,
and temperature is a required variable in the data table. Since our data is not temperature-dependent, we
will use the same value of temperature (0 [C]) at each strain/stress point.

Lines 20-23
Since the calculation for plastic strain depends on Young's Modulus, we use the GetData() method to
get the Young’s Modulus value from the elasticity property. Within Engineering Data, all property values
are stored and returned as quantities which include both a numeric value and a unit. See Lines 35-41 for
further discussion on quantities and units.

Lines 25-32
Here we open our text data file and read each line one at a time. If the line begins with a comment character
'#', we continue to the next line in the file.

Lines 34-35
The Python split() function is used to break the comma delimited line and return the separate values
into variables for strain and stress.

Lines 37-39
In this example we are creating explicit unit-based quantities for stress and strain values, to ensure dimen-
sional and unit consistency in later calculations.

Material property data (or any other quantity data) can be set either as a quantity (i.e., with value
and units), or as a simple numeric value (see Specifying Quantities Without Units). If a numeric value
is supplied, the units are assumed to be the same as the current project units for the variable (it is
the script writer’s responsibility to ensure the numeric data and project units are consistent).

Line 43-45
Since temperature is a simple constant value, we will specify temperature as a numeric value (without
units), and the units will be taken from the current project unit system. We append 0 into the list of tem-
perature data for this strain/stress pair.

Line 46
Here we calculate plastic strain based on the available quantities and append it to the variable list. Math-
ematical operations involving quantities enforce dimensional consistency and automatically perform unit
conversion as necessary to generate a consistent result.

Line 47
Stress data is also appended to the appropriate list.

Lines 50-52
A new property for Multilinear Isotropic Hardening is created within Polyethylene.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 27
Using Scripting in ANSYS Workbench

Lines 53-57
The SetData() method is used to set single value or tabular data for material properties. Some properties
can contain more than one data table, so the SheetName and SheetQualifiers arguments are used to specify
the exact data table to be accessed. The Variables argument specifies one or more variables in the table
to be set. The Values argument specifies the values that correspond to each variable.

Lines 59-62
Finally we save the project, overwriting if one already exists.

Mechanical APDL and Sending Commands to Integrated Applications

As discussed in Scripting and Data-Integrated Applications (p. 6), ANSYS Workbench can interact with
the native scripting language of many of its integrated applications. This example demonstrates
scripting interaction with Mechanical APDL and the use of the SendCommand method to pass APDL
commands to the editor. After you extract the ScriptingGuideExamples.zip file, you will find
the files for this example in the Sending_Commands directory.

The case under consideration is a simple stress analysis of a bar that is defined in a Mechanical APDL
input file. The bar dimensions and output displacement have been parameterized within Mechanical
APDL. In this example, you wish to write a script that automates this analysis for a number of different
bar lengths, and write an ANSYS .cdb file for each case for future processing.

To automate this process, we will write an ANSYS Workbench script that performs the operations de-
scribed below:

1. Create a system for Mechanical APDL analysis, and loads the specified ANSYS input file.

2. Publishes some of the parameters from the input file to ANSYS Workbench.

3. Loops through a list of desired bar lengths and, for each value, does the following:

a. Sets the length parameter value.

b. Updates the project to compute displacement for the new length.

c. Sends APDL commands to Mechanical APDL to write the .cdb file to a desired location.

Sample Data File The sample data file to be used in this example follows:
! set parameters
xlen=3
ylen=4
zlen=7

! define model
/prep7
block,,xlen,,ylen,,zlen
et,1,185
mp,ex,1,1e6
mp,prxy,1,0.3
vmesh,all
nsel,s,loc,z,0
d,all,all
nsel,s,loc,y,ylen
sf,all,pres,125
alls
fini

! obtain the solution

/solution

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

solve
fini

! retrieve results
/post1
! get the max stress at the fixed end
nsel,s,loc,x,xlen
nsel,r,loc,y,ylen
nsel,r,loc,z,0
*GET,out_my_node_stress,NODE,1,NXTH
*GET,out_seqv,NODE,out_my_node_stress,S,EQV
! get the max displacement at the free end
nsel,s,loc,x,xlen
nsel,r,loc,y,ylen
nsel,r,loc,z,zlen
*GET,out_my_node_def,NODE,1,NXTH
*GET,out_uy,NODE,out_my_node_def,U,Y
alls
fini

Workbench Script The script for this example follows. Each line is numbered for reference in the
discussion that follows.
1 # Import the 'os' module, which provides a portable way of using
2 # operating system dependent functionality
3 import os
4
5 workDir = "ScriptingGuideExamples/Sending_Commands/"
6
7 # Specify the Mechanical APDL Input file to be processed
8 inputFile = AbsUserPathName(workDir + "bar.dat")
9
10 # Provide a list of bar length (Z) values to solve and write CDB files for.
11 # Note: We expect '0' to fail.
12 zValues = [3,5,0,12,15]
13
14 # Open a log file to record script progress
15 logFile = open(AbsUserPathName(workDir + "my_bar_script.log"),"w")
16
17 # Start a new project and create the Mechanical APDL system
18 Reset()
19 template1 = GetTemplate(TemplateName="Mechanical APDL")
20 system1 = template1.CreateSystem()
21
22 # Read the input file into the Mechanical APDL Setup
23 setup1 = system1.GetContainer(ComponentName="Setup")
24 mapdlInputFile1 = setup1.AddInputFile(FilePath=inputFile)
25
26
27 # Create Workbench parameters from two of the Mechanical APDL parameters
28 # in the input file
29 mapdlInputFile1.PublishMapdlParameter(Name="ZLEN")
30 parameter1 = Parameters.GetParameter(Name="P1")
31
32 mapdlInputFile1.PublishMapdlParameter(
33 Name="OUT_UY",
34 IsDirectOutput=True)
35 parameter2 = Parameters.GetParameter(Name="P2")
36
37 # Save the initial project definition.
38 Save(
39 FilePath=AbsUserPathName(workDir + "myBar.wbpj"),
40 Overwrite=True)
41
42 # Loop through all provided bar lengths
43 for zVal in zValues:
44
45 # Set the Z (length) parameter expression
46 parameter1.Expression = str(zVal)
47 logFile.write("Updating for z = %s\n" % zVal)
48

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 29
Using Scripting in ANSYS Workbench

49 # Update the project for the new parameter value, and report
50 # success or failure to the log file.
51 try:
52 Update()
53 except:
54 logFile.write(" Update failed.\n")
55 else:
56 logFile.write(" Update succeeded. UY = %s\n" % parameter2.Value)
57
58 # Generate the name of the CDB file to save
59 cdbName = os.path.join(GetUserFilesDirectory(), "my_bar_" + str(zVal) + ".cdb")
60 cdbName = cdbName.replace("\\","/")
61
62 # Delete the cdb file if it already exists, to prevent
63 # Mechanical APDL from promting us about overwrite.
64 if os.path.exists(cdbName):
65 os.remove(cdbName)
66
67 # Generate the APDL command to save the CDB file and send it.
68 apdlCmd = "cdwr,db,%s" % cdbName
69 setup1.SendCommand(Command=apdlCmd)
70 logFile.write(" CDB written to %s\n" % cdbName)
71
72 # Save the final project state.
73 Save()
74 logFile.close()

Log File The log file generated by the above script should look like the following:
Change all the forward slashes (\) with back slashes (/)
Updating for z = 3
Update succeeded. UY = -0.00083352729
CDB written to C:\Users\neUser\Demo\ScriptExample4\myBar_files\user_files\my_bar_3.cdb
Updating for z = 5
Update succeeded. UY = -0.00304172391
CDB written to C:\Users\neUser\Demo\ScriptExample4\myBar_files\user_files\my_bar_5.cdb
Updating for z = 0
Update failed.
CDB written to C:\Users\neUser\Demo\ScriptExample4\myBar_files\user_files\my_bar_0.cdb
Updating for z = 12
Update succeeded. UY = -0.0504979576
CDB written to C:\Users\neUser\Demo\ScriptExample4\myBar_files\user_files\my_bar_12.cdb
Updating for z = 15
Update succeeded. UY = -0.121175623
CDB written to C:\Users\neUser\Demo\ScriptExample4\myBar_files\user_files\my_bar_15.cdb

Discussion This example demonstrates interaction with Mechanical APDL to operate on an existing
ANSYS input file, and send APDL commands. The following discussion refers to the specified line numbers
of the example script to illustrate some of these concepts and constructs. Discussion points from earlier
examples will not be repeated here.

Lines 1-15
The initial lines of the script import useful modules, define controlling variables and create a log file to
record script progress.

Lines 17-20
Here we start a new project and create a new Mechanical APDL system.

Lines 22-24
We use the AddInputFile method on the Mechanical APDL Setup container to read and process the
specified input file.

Lines 27-35
The input file contains a number of values that could be parameterized. Here we promote two of them to
be parameters that are controlled and displayed at the ANSYS Workbench level. We access the ZLEN

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
30 of ANSYS, Inc. and its subsidiaries and affiliates.
 Usage Examples

parameter as an input to set the bar length, and the OUT_UY parameter as an output to track maximum
Y displacement.

Lines 40
We save the project to a permanent location. Until the project is saved, all files and project directories are
based on a temporary location. By saving the project, we can more accurately report the directory that
holds the .cdb files. The script will still function if the project is not first saved, but will report the temporary
location for the project files.

Lines 42-47
We start the loop for the desired bar length values and set the Z parameter appropriately. Note that the
Expression for a parameter is a string as it can support complex functions. The Python str() function is
used to convert the Z value to a string.

Lines 49-56
We call the project Update() command to recalculate the project based on the new length parameter
value, and use Python exception handling to report the success or failure of the update. The value of output
displacement is reported on successful update.

Lines 58-60
We use the project user_files directory to store the .cdb files for each case. Here we generate the
desired .cdb file path based on the GetUserFilesDirectory() query and use os.path.join to
combine that with the desired file name.

Mechanical APDL typically uses forward slashes in file paths by convention, so we convert any
backslashes to forward in line 62.

Line 62-65
Mechanical APDL interactively prompts you to overwrite a .cdb file if one already exists, so we ensure no
.cdb file of the desired name is present.

Lines 67-70
We generate an APDL command string to write the .cdb file to the desired file path and use the Send-
Command method to execute it. While this example just passes a single line command, the command
string can contain multiple commands separated by newlines.

Lines 72-74
We complete the script by saving the final project state and closing the log file.

Updating a Workbench Project and Parameters from Excel

This example demonstrates the mechanics of interacting with Microsoft Excel from within an ANSYS
Workbench script, and connecting ANSYS Workbench operations to UI Control events issues by Microsoft
Excel (or other similar interfaces). The physics in this example is a simple cantilever beam, where the
beam length and load are input parameters, and the resulting deflection is an output parameter. The
case is defined within ANSYS Workbench as a Static Structural system with the appropriate parameters
created. After you extract the ScriptingGuideExamples.zip file, you will find the files for this
example in the Excel_Parameter_Scripting directory.

Of primary interest in this example is that user interaction with this project will be done via Microsoft
Excel, where you will:

1. Set the input parameter values within an Excel Workbook.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 31
Using Scripting in ANSYS Workbench

2. Press an 'Update Workbench' button in Excel.

3. See an 'Updating...' message in Excel as the calculation proceeds, and the output parameter value updated
within the Workbook when the calculation is complete.

When the ANSYS Workbench script below is executed, it opens the necessary ANSYS Workbench project
and Excel Workbook, and then establishes an event connection so that an ANSYS Workbench script
function is executed at the press of the button within Excel.

Workbench Script The script for this example follows. Each line is numbered for reference in the
discussion that follows.
1 # IronPython imports to enable Excel interop
2 import clr
3 clr.AddReference("Microsoft.Office.Interop.Excel")
4 import Microsoft.Office.Interop.Excel as Excel
5
6 workingDir = AbsUserPathName("ScriptingGuideExamples/Excel_Parameter_Scripting/")
7
8 def updateHandler():
9
10 # Define key ranges in the Workbook
11 lengthCell = worksheet.Range["A3"]
12 loadCell = worksheet.Range["B3"]
13 defCell = worksheet.Range["C3"]
14
15 # Get the Workbench Parameters
16 lengthParam = Parameters.GetParameter(Name="P1")
17 loadParam = Parameters.GetParameter(Name="P2")
18 defParam = Parameters.GetParameter(Name="P3")
19
20 # Assign values to the input parameters
21 lengthParam.Expression = lengthCell.Value2.ToString()
22 loadParam.Expression = loadCell.Value2.ToString() + " [N]"
23
24 # Mark the deformation parameter as updating in the workbook
25 defCell.Value2="Updating..."
26
27 # Run the project update
28 Update()
29
30 # Update the workbook value from the WB parameter
31 defCell.Value2 = defParam.Value
32
33
34 # Open the Workbench Project
35 Open(FilePath = workingDir + "ExcelParameterScripting.wbpj")
36

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
32 of ANSYS, Inc. and its subsidiaries and affiliates.
 Usage Examples

37 # Open Excel and the workbook

38 ex = Excel.ApplicationClass()
39 ex.Visible = True
40 workbook = ex.Workbooks.Open(workingDir + "ParameterExample.xlsx")
41 worksheet=workbook.ActiveSheet
42
43 #Apply the update handler to the workbook button
44 OLEbutton = worksheet.OLEObjects("CommandButton1")
45 OLEbutton.Object.CLICK += updateHandler
46

Discussion This example demonstrates a number of the typical programming constructs necessary
for ANSYS Workbench scripting to interact with the Common Language Runtime (CLR) API exposed by
Microsoft Excel and similar applications.

Lines 1-4
The clr module is imported to enable IronPython to load and interact with CLR modules from other ap-
plications. In this example we add a CLR reference to the Microsoft Excel Interop assembly, and then import
the module as the Excel namespace.

Line 6
The working directory is set, so that the script can load the Project and Excel Workbook from the specified
location. When completing this example, this line will need to be modified to reflect your working location.

Lines 8-31
An updateHandler() function is created that performs all the necessary actions to interact with Excel
and update the ANSYS Workbench project. This function is connected to the CLICK event of the Excel
button on line 45 of this script.

Lines 10-13
Specific cells of interest in the Workbook are created as named references in the script to facilitate later
use of these cells. In this instance, the cells that hold the values of the two input parameters and one output
parameter are given named references.

Lines 15-18
References to the three parameters exposed by the Static Structural system are also assigned to variables
for later use.

Lines 20-22
The Expression property defining the input parameters are set based on the values of the associated cells
in the Excel Workbook. Note the 'Value2' property is used because it has simpler interaction when working
with a single cell value.

Lines 24-25
The script sets the value of the output parameter cell in the workbook to 'Updating...' while calculation
proceeds.

Lines 27-28
The Update() command is executed to update the project based on the new input parameter values.

Lines 30-31
When the Update is complete, we update the output cell value in the Workbook with the parameter value
in the Project.

Note the reference to defparam.Value.Value. The Value property of a parameter can have
different types (Numeric, String, Boolean, Quantity, etc). In this instance, it is a Quantity, which in

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 33
Using Scripting in ANSYS Workbench

turn has properties for its Value and Unit. Therefore defparam.Value.Value is the numeric
part of the Quantity that is the parameter's current value.

Lines 34-35
The lines following the UpdateHandler definition are those first executed when the script executes. The
first operation is to load the Workbench Project containing the parameterized Static Structural analysis.

Lines 37-39
Using the imported Excel namespace, we create an instance of the Excel application and make it visible.

Lines 40-41
We open the Excel workbook that contains the parameter table and 'Update' button, and get a reference
to the primary (active) worksheet in the book.

Lines 43-44
We get a reference to the named OLE button (CommandButton1) that is present in the worksheet. This
button was added to the worksheet by inserting the control within Excel, but no other macros or code
associated with this button is required in the workbook.

Line 45
The updateHandler() function is added as an event handler to the CLICK event on the command
button. Whenever the button is clicked, the associated ANSYS Workbench script function is executed.

Set Up, Solve, and Post-Process a Fluids Study Using AIM

This example demonstrates a basic fluids study using scripting in ANSYS AIM. After you extract the
ScriptingGuideExamples.zip file, you will find the files for this example in the AIM_Flu-
ids_Study directory.

ANSYS AIM Script The script for this example follows. Each line is numbered for reference in the
discussion that follows.
1 # encoding: utf-8
2 SetScriptVersion(Version="16.0")
3 Reset()
4
5 # Define working directory and CAD file
6 workingDir = r"D:\ScriptingGuideExamples\AIM_Fluids_Study\"
7 CADFile = "TrumpetValve.agdb"
8 projectName = "sce-4-cfd.wbpj"
9
10 import os
11 fullPath = os.path.join(workingDir, CADFile)
12 savePath = os.path.join(workingDir, projectName)
13
14 with Transaction():
15 # Define Study system and access the container
16 system1 = GetSystem(Name="Study")
17 study1 = system1.GetContainer(ComponentName="Study")
18
19 # Define the Tasks and Groups
20 importComponent1 = Study.CreateTask(Type="Import", System=system1)
21 meshingComponent1 = Study.CreateTask(Type="Meshing", System=system1)
22
23 physicsDefinitionComponent1 = Study.CreateTask(Type="Physics Definition",System=system1)
24 solvePhysicsComponent1 = Study.CreateTask(Type="Solve Physics",System=system1)
25 # physicsDefinitionComponent1 and solvePhysicsComponent1 will be grouped together
26
27 physicsSolutionGroup1 = Study.CreateGroup(Name="Physics Solution")
28 physicsSolutionGroup1.Add(Component=physicsDefinitionComponent1)
29 physicsSolutionGroup1.Add(Component=solvePhysicsComponent1)
30

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
34 of ANSYS, Inc. and its subsidiaries and affiliates.
 Usage Examples

31 resultsEvaluationComponent1 = Study.CreateTask(Type="Results Evaluation", System=system1)

32
33 # Define the Import
34 import1 = importComponent1.GetTaskObject()
35
36 # Define the Part Meshing properties
37 partMesh1 = meshingComponent1.GetTaskObject()
38 partMesh1.EngineeringIntent = "FluidFlow"
39 partMesh1.GlobalMeshSizingAttributes.Smoothing = "High"
40
41 # Define the Solution properties
42 physicsDefinition1 = physicsDefinitionComponent1.GetTaskObject()
43 physicsDefinition1.CalculationType = "Static"
44
45 # Define PhysicsRegion, SolverSettings, Material
46 physicsRegion1 = study1.CreateEntity(Type="PhysicsRegion",AssociatedObject=physicsDefinition1)
47 physicsRegion1.PhysicsType = "Fluid"
48 physicsRegion1.Location = "AllBodies()"
49
50 solverSettings1 = study1.CreateEntity(Type="SolverSettings", Association=physicsDefinition1)
51
52 material1 = study1.CreateEntity(Type="Material", AssociatedObject=physicsDefinition1)
53 material1.ImportEngineeringData(Name="Water")
54
55 materialAssignment1 = study1.CreateEntity(Type="MaterialAssignment",AssociatedObject=physicsDefinition1)
56 materialAssignment1.Material = material1
57 materialAssignment1.Location = [physicsRegion1]
58
59 # Define upstream-downstream links between the tasks
60 AddSourceToComponentInSystem(SourceComponent=importComponent1, TargetComponent=meshingComponent1)
61 AddSourceToComponentInSystem(SourceComponent=meshingComponent1, TargetComponent=physicsDefinitionComponent1)
62 AddSourceToComponentInSystem(SourceComponent=physicsDefinitionComponent1, TargetComponent=solvePhysicsCompon
63 AddSourceToComponentInSystem(SourceComponent=solvePhysicsComponent1, TargetComponent=resultsEvaluationCompon
64
65 # Add a Transcript tab
66 transcript1 = study1.CreateEntity(Type="Transcript", Association=physicsDefinition1)
67
68 # Define Results
69 results1 = resultsEvaluationComponent1.GetTaskObject()
70
71 with Transaction():
72 # Import the CAD
73 Study.AddGeometryImportSourceOperation(ObjectReference=import1)
74 geometryImportSource1 = study1.GetGeometryImportSource(Name="GeometryImportSource 1")
75 geometryImportSource1.FilePath = fullPath
76 geometryImportSource1.GeometryPreferences.ImportNamedSelections = "True"
77 geometryImportSource1.GeometryPreferences.NamedSelectionKey = ""
78
79 importComponent1.Update(AllDependencies=True)
80
81 # Refresh other cells
82 meshingComponent1.Refresh()
83 physicsDefinitionComponent1.Refresh()
84 resultsEvaluationComponent1.Refresh()
85
86 # Define Mesh controls (boundary layers on wall)
87 with Transaction():
88 meshControlLocalInflation1 = study1.CreateEntity(Type="MeshControlLocalInflation", AssociatedObject=partMesh
89 meshControlLocalInflation1.Location = 'GetSelectionSet("@wall")'
90 meshControlLocalInflation1.MaximumLayers = "5"
91 meshControlLocalInflation1.GrowthRate = "1.2"
92
93 # Define Solver Controls
94 with Transaction():
95 numericalControls1 = study1.GetNumericalControls(Name="NumericalControls 1")
96 numericalControls1.SolutionControl.CouplingControl.PressureVelocityCoupling.Option = "SIMPLE"
97 numericalControls1.SolutionControl.ExplicitRelaxation["pressure"].ExplicitRelaxFactor = "0.4"
98 numericalControls1.SolutionControl.ExplicitRelaxation["velocity"].ExplicitRelaxFactor = "0.6"
99
100 with Transaction():
101 solutionControls1 = study1.GetSolutionControls(Name="SolutionControls 1")
102 solutionControls1.CalculationControl.IterationControl.MaximumNumberOfIterations = "250"

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 35
Using Scripting in ANSYS Workbench

103
104 # Define Boundary Conditions
105 with Transaction():
106 inletBoundary1 = study1.CreateEntity(Type="InletBoundary", AssociatedObject=physicsRegion1)
107 inletBoundary1.Location = 'GetSelectionSet("@inlet")'
108 inletBoundary1.Flow.Velocity.Magnitude = "3.0 [m s^-1]"
109
110 with Transaction():
111 outletBoundary1 = study1.CreateEntity(Type="OutletBoundary", AssociatedObject=physicsRegion1)
112 outletBoundary1.Location = 'GetSelectionSet("@outlet")'
113 outletBoundary1.Flow.Pressure.GaugeStaticPressure = "0 [Pa]"
114
115 with Transaction():
116 wallBoundary1 = study1.CreateEntity(Type="WallBoundary", AssociatedObject=physicsRegion1)
117 wallBoundary1.Location = 'GetSelectionSet("@wall")'
118
119 # Add post-processing items (contours, vectors and streamlines) on boundaries and cut-planes
120 with Transaction():
121 contourResult1 = study1.CreateEntity(Type="ContourResult", AssociatedObject=results1)
122 contourResult1.Variable = "Pressure"
123 contourResult1.Location = 'GetSelectionSet("@wall")'
124 contourResult1.DisplayText = "WallPressure"
125
126 with Transaction():
127 vectorResult1 = study1.CreateEntity(Type="VectorResult", AssociatedObject=results1)
128 vectorResult1.Variable = "Velocity"
129 vectorResult1.Location = 'GetSelectionSet("@outlet")'
130 vectorResult1.DisplayText = "OutletVelocity"
131
132 with Transaction():
133 plane1 = study1.CreateEntity(Type="Plane", AssociatedObject=results1)
134 plane1.DisplayText = "Z0"
135
136 with Transaction():
137 plane2 = study1.CreateEntity(Type="Plane", AssociatedObject=results1)
138 plane2.Transformation.RotationAngle = "90 [degree]"
139 plane2.DisplayText = "Y0"
140
141 with Transaction():
142 contourResult2 = study1.CreateEntity(Type="ContourResult", AssociatedObject=results1)
143 contourResult2.Variable = "Pressure"
144 contourResult2.Location = [plane2] # Y0
145 contourResult2.DisplayText = "Y0Pressure"
146
147 with Transaction():
148 vectorResult2 = study1.CreateEntity(Type="VectorResult", AssociatedObject=results1)
149 vectorResult2.Variable = "Velocity"
150 vectorResult2.Location = [plane1] # Z0
151 vectorResult2.DisplayText = "Z0Velocity"
152
153 with Transaction():
154 streamLine1 = study1.CreateEntity(Type="StreamLine",AssociatedObject=results1)
155 streamLine1.Location = 'GetSelectionSet("@inlet")'
156 streamLine1.DisplayText = "Streamlines_from_inlet"
157
158 # Generate the Mesh
159 meshingComponent1.Update(AllDependencies=True)
160
161 # Perform the Simulation
162 with Transaction():
163 physicsDefinitionComponent1.Update(AllDependencies=True)
164 solvePhysicsComponent1.Update(AllDependencies=True)
165
166 # Update the Results
167 resultsEvaluationComponent1.Update(AllDependencies=True)
168
169 # Save project to working directory
170 Save(FilePath=savePath, Overwrite=True)
171
172 # Exit from Workbench AIM
173

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
36 of ANSYS, Inc. and its subsidiaries and affiliates.
 Usage Examples

Discussion A description of each line follows.

Line 3
Reset() command starts a new session.

Line 6
The working directory is set, so that the script can load the geometry file from the specified location. When
completing this example, this line will need to be modified to reflect your working location.

Line 10
The 'os' module used in this script provides capabilities for interacting with operating system services.
Refer to the Python Standard Library documentation for details on all available modules.

Lines 14-63
This part defines a basic CFD analysis template. All the different tasks (e.g., geometry import, mesh gener-
ation, solution and results) are created and populated.

Lines 19-31
Different tasks (e.g., geometry import, mesh generation, solution, and results) are created.

Lines 36-39
Define some global properties for the mesh generation.

Lines 45-57
Define PhysicsRegion, SolverSettings, and Material for the solution.

Lines 59-63
Define links between the tasks, i.e., meshing task takes the geometry from the import task as input; solution
task takes the mesh generated from the meshing task, etc.

Lines 65-66
Add a Transcript tab so that solver output information can be monitored.

Lines 71-84
The geometry file is imported (along all NamedSelections) and other tasks are refreshed as their upstream
data is updated.

Lines 86-91
Define a boundary layers mesh control on the "wall" NamedSelection.

Lines 93-102
Define Solver Controls

Lines 104-117
Define Boundary Conditions.

Lines 105-108
3.0 m/s velocity magnitude for the "inlet" Named Selection.

Lines 110-113
0 Pa static pressure for the "outlet" Named Selection.

Lines 115-117
Wall for the "wall" Named Selection.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 37
Using Scripting in ANSYS Workbench

Lines 120-156
Add post-processing items (contours, vectors and streamlines) on boundaries and cut-planes.

Line 159
Generate the mesh.

Line 162-164
Perform the simulation.

Line 166-167
Evaluate all of the results.

Line 170
Save the project files.

Set Up, Solve, and Post-Process a Structural Study Using AIM

This example demonstrates a basic structural study using scripting in ANSYS AIM. After you extract the
ScriptingGuideExamples.zip file, you will find the files for this example in the AIM_Structur-
al_Study directory.

ANSYS AIM Script The script for this example follows.

1 # encoding: utf-8
2 SetScriptVersion(Version="16.0")
3 Reset()
4
5 # Define working directory
6 workingDir = r"D:\ScriptingGuideExamples\AIM_Structural_Study\"
7 CADFile = "gearcasing.agdb"
8 projectName = "sce-4-mech.wbpj"
9
10 import os
11 fullPath = os.path.join(workingDir, CADFile)
12 savePath = os.path.join(workingDir, projectName)
13
14 with Transaction():
15 # Define Study system and access the container
16 system1 = GetSystem(Name="Study")
17 study1 = system1.GetContainer(ComponentName="Study")
18
19 # Define the Tasks and Groups
20 importComponent1 = Study.CreateTask(Type="Import", System=system1)
21 meshingComponent1 = Study.CreateTask(Type="Meshing", System=system1)
22
23 physicsDefinitionComponent1 = Study.CreateTask(Type="Physics Definition",System=system1)
24 solvePhysicsComponent1 = Study.CreateTask(Type="Solve Physics",System=system1)
25 # physicsDefinitionComponent1 and solvePhysicsComponent1 will be grouped together
26
27 physicsSolutionGroup1 = Study.CreateGroup(Name="Physics Solution")
28 physicsSolutionGroup1.Add(Component=physicsDefinitionComponent1)
29 physicsSolutionGroup1.Add(Component=solvePhysicsComponent1)
30
31 resultsEvaluationComponent1 = Study.CreateTask(Type="Results Evaluation", System=system1)
32
33 # Define the Import
34 import1 = importComponent1.GetTaskObject()
35
36 # Define the Part Meshing properties
37 partMesh1 = meshingComponent1.GetTaskObject()
38 partMesh1.EngineeringIntent = "StructuralOrThermalOrElectricConduction"
39 partMesh1.GlobalMeshSizingAttributes.UseAdvancedSizeFunction = "Adaptive"
40
41 # Define the Solution properties
42 physicsDefinition1 = physicsDefinitionComponent1.GetTaskObject()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
38 of ANSYS, Inc. and its subsidiaries and affiliates.
 Usage Examples

43 physicsDefinition1.CalculationType = "Static"
44
45 # Define PhysicsRegion, SolverSettings, Material
46 physicsRegion1 = study1.CreateEntity(Type="PhysicsRegion",AssociatedObject=physicsDefinition1)
47 physicsRegion1.PhysicsType = "Structural"
48 physicsRegion1.Location = "AllBodies()"
49
50 solverSettings1 = study1.CreateEntity(Type="SolverSettings",AssociatedObject=physicsDefinition1)
51
52 material1 = study1.CreateEntity(Type="Material", AssociatedObject=physicsDefinition1)
53 material1.ImportEngineeringData(Name="Structural Steel")
54
55 materialAssignment1 = study1.CreateEntity(Type="MaterialAssignment",AssociatedObject=physicsDefinition1)
56 materialAssignment1.Material = material1
57 materialAssignment1.Location = [physicsRegion1]
58
59 # Define upstream-downstream links between the tasks
60 AddSourceToComponentInSystem(SourceComponent=importComponent1, TargetComponent=meshingComponent1)
61 AddSourceToComponentInSystem(SourceComponent=meshingComponent1, TargetComponent=physicsDefinitionComponent1)
62 AddSourceToComponentInSystem(SourceComponent=physicsDefinitionComponent1, TargetComponent=solvePhysicsCompon
63 AddSourceToComponentInSystem(SourceComponent=solvePhysicsComponent1, TargetComponent=resultsEvaluationCompon
64
65 # Add a Transcript tab
66 transcript1 = study1.CreateEntity(Type="Transcript", AssociatedObject=physicsDefinition1)
67
68 # Define Results
69 results1 = resultsEvaluationComponent1.GetTaskObject()
70
71 with Transaction():
72 # Import the CAD
73 Study.AddGeometryImportSourceOperation(ObjectReference=import1)
74 geometryImportSource1 = study1.GetGeometryImportSource(Name="GeometryImportSource 1")
75 geometryImportSource1.FilePath = fullPath
76 geometryImportSource1.GeometryPreferences.ImportNamedSelections = "True"
77 geometryImportSource1.GeometryPreferences.NamedSelectionKey = ""
78
79 importComponent1.Update(AllDependencies=True)
80
81 # Refresh other cells
82 meshingComponent1.Refresh()
83 physicsDefinitionComponent1.Refresh()
84 resultsEvaluationComponent1.Refresh()
85
86 # Define Boundary Conditions
87 with Transaction():
88 support1 = study1.CreateEntity(Type="Support", AssociatedObject=physicsRegion1)
89 support1.Location = 'GetSelectionSet("@side1")'
90
91 with Transaction():
92 pressure1 = study1.CreateEntity(Type="Pressure", AssociatedObject=physicsRegion1)
93 pressure1.Location = 'GetSelectionSet("@side2")'
94 pressure1.Magnitude = "1.0E7 [Pa]"
95 # Define this as a input Parameter
96 parameter1 = Parameters.CreateParameter(Entity=pressure1, PropertyName="Magnitude", IsOutput=False)
97 parameter1.Expression = str(pressure1.Magnitude)
98 parameter1.DisplayText="Pressure1"
99
100 # Add post-processing contours
101 with Transaction():
102 contourResult1 = study1.CreateEntity(Type="ContourResult", AssociatedObject=results1)
103 contourResult1.Variable = "Displacement.mag"
104 contourResult1.Location = "AllBodies()"
105 contourResult1.DisplayText = "Total Deformation"
106 # Define this as a output Parameter
107 parameter2 = Parameters.CreateParameter(Entity=contourResult1, PropertyName="Summary.Max", IsOutput=True, Is
108 parameter2.DisplayText="Maximum Deformation"
109
110 with Transaction():
111 contourResult2 = study1.CreateEntity(Type="ContourResult", AssociatedObject=results1)
112 contourResult2.Variable = "Stress.eqv"
113 contourResult2.Location = "AllBodies()"
114 contourResult2.DisplayText = "Eqv Stress"

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 39
Using Scripting in ANSYS Workbench

115
116 with Transaction():
117 vectorResult1 = study1.CreateEntity(Type="VectorResult", AssociatedObject=results1)
118 vectorResult1.Variable = "Displacement"
119 vectorResult1.Location = "AllBodies()"
120
121 # Generate the Mesh
122 meshingComponent1.Update(AllDependencies=True)
123
124 # Perform the Simulation
125 # Perform the Simulation
126 with Transaction():
127 physicsDefinitionComponent1.Update(AllDependencies=True)
128 solvePhysicsComponent1.Update(AllDependencies=True)
129
130 # Update the Results
131 resultsEvaluationComponent1.Update(AllDependencies=True)
132
133 # Save project to working directory
134 Save(FilePath=savePath, Overwrite=True)
135
136 # Exit from Workbench AIM
137

Discussion A description of each line follows.

Line 3
Reset() command starts a new session.

Line 6
The working directory is set, so that the script can load the geometry file from the specified location. When
completing this example, this line will need to be modified to reflect your working location.

Line 10-12
The 'os' module used in this script provides capabilities for interacting with operating system services.
Refer to the Python Standard Library documentation for details on all available modules.

Lines 14-69
This part defines a basic Static Structural analysis template. All the different tasks (e.g., geometry import,
mesh generation, solution and results) are created and populated.

Lines 19-34
Different tasks (e.g., geometry import, mesh generation, solution, and results) are created.

Lines 36-39
Define some global properties for the mesh generation.

Lines 45-57
Define PhysicsRegion, SolverSettings, and Material for the solution.

Lines 59-63
Define links between the tasks, i.e., meshing task takes the geometry from the import task as input; solution
task takes the mesh generated from the meshing task, etc.

Lines 65-66
Add a Transcript tab so that solver output information can be monitored.

Lines 71-84
The geometry file is imported (along all NamedSelections) and other tasks are refreshed as their upstream
data is updated.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
40 of ANSYS, Inc. and its subsidiaries and affiliates.
 Usage Examples

Lines 88-89
Define a fixed support boundary condition on "side1" Named Selection.

Lines 91-98
Define a 1.0E7 Pa pressure load "side2" Named Selection and make it an input parameter, named "Pressure1".

Lines 101-105
Create a displacement magnitude contours on all bodies.

Lines 107-108
Make the maximum displacement magnitude as a output parameter, named "Maximum Deformation".

Lines 110-119
Create more contour and vector results.

Line 122
Generate the mesh.

Line 126-128
Perform the simulation.

Line 131
Evaluate all of the results.

Line 133
Save the project files.

Updating a Workbench Project and Parameters from Excel Using AIM

This example is identical to the previous example but interacts with ANSYS AIM. As in the previous ex-
ample, this example demonstrates the mechanics of interacting with Microsoft Excel from within a script
and connecting ANSYS AIM operations to UI Control events issues by Microsoft Excel (or other similar
interfaces). After you extract the ScriptingGuideExamples.zip file, you will find the files for this
example in the AIM_Excel_Parameter_Scripting directory.

Of primary interest in this example is that user interaction with this project will be done via Microsoft
Excel, where you will:

1. Set the input parameter values within an Excel Workbook.

2. Press an 'Update AIM' button in Excel.

3. See an 'Updating ...' message in Excel as the calculation proceeds, and the output parameter value updated
within the Workbook when the calculation is complete.

When the script below is executed, it opens the necessary ANSYS AIM project and Excel Workbook, and
then establishes an event connection so that an ANSYS AIM script function is executed at the press of
the button within Excel.

Script The script for this example follows. Each line is numbered for reference in the discussion that
follows.
1 SetScriptVersion(Version="16.0.260")
2 Reset()
3 # IronPython imports to enable Excel interop
4 import clr

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 41
Using Scripting in ANSYS Workbench

5 import os
6 clr.AddReference("Microsoft.Office.Interop.Excel")
7 import Microsoft.Office.Interop.Excel as Excel
8
9 # Define working directory
10 workingDir = r"D:\ScriptingGuideExamples\AIM_Excel_Parameter_Scripting\"
11 def updateHandler():
12
13 # Update can take long, so disable the Excel warning -
14 # "Excel is waiting for another application to complete an OLE action"
15 ex.Application.DisplayAlerts = False
16
17 # Define key ranges in the Workbook
18 lengthCell = worksheet.Range["A3"]
19 loadCell = worksheet.Range["B3"]
20 defCell = worksheet.Range["C3"]
21
22 # Get the Workbench Parameters
23 lengthParam = Parameters.GetParameter(Name="P1")
24 loadParam = Parameters.GetParameter(Name="P2")
25 defParam = Parameters.GetParameter(Name="P3")
26
27 # Assign values to the input parameters
28 lengthParam.Expression = lengthCell.Value2.ToString() + " [cm]"
29 loadParam.Expression = loadCell.Value2.ToString() + " [N]"
30
31 # Mark the deformation parameter as updating in the workbook
32 defCell.Value2="Updating..."
33
34 # Run the project update
35 Update()
36
37 # Update the workbook value from the WB parameter
38 # Access the deformation value in "m"
39 defValue = defParam.Value.ConvertUnit("m")
40 defCell.Value2 = defValue.Value
41
42 # restore alert setting
43 ex.Application.DisplayAlerts = True
44
45 # Open the Workbench Project
46 if (os.path.exists(os.path.join(workingDir, "AIMExcelParameterScripting.wbpj"))):
47 Open(FilePath = os.path.join(workingDir, "AIMExcelParameterScripting.wbpj"))
48 else:
49 RunScript(FilePath = os.path.join(workingDir,"AIMExcelParameterScriptingProject.wbjn"))
50
51 # Open Excel and the workbook
52 ex = Excel.ApplicationClass()
53 ex.Visible = True
54 workbook = ex.Workbooks.Open(os.path.join(workingDir , "ParameterExample.xlsx"))
55 worksheet=workbook.ActiveSheet
56
57 #Apply the update handler to the workbook button
58 OLEbutton = worksheet.OLEObjects("CommandButton1")
59 commandButton = OLEbutton.Object
60 commandButton.CLICK += updateHandler
61
62

Discussion This example demonstrates a number of the typical programming constructs necessary
for ANSYS Workbench scripting to interact with the Common Language Runtime (CLR) API exposed by
Microsoft Excel and similar applications.

Lines 3-7
The clr module is imported to enable IronPython to load and interact with CLR modules from other ap-
plications. In this example we add a CLR reference to the Microsoft Excel Interop assembly, and then import
the module as the Excel namespace. The 'os' module used in this script provides capabilities for interacting
with operating system services. Refer to the Python Standard Library documentation for details on all
available modules.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
42 of ANSYS, Inc. and its subsidiaries and affiliates.
 Usage Examples

Line 10
The working directory is set, so that the script can load the Project and Excel Workbook from the specified
location. When completing this example, this line will need to be modified to reflect your working location.

Lines 11-43
An updateHandler() function is created that performs all the necessary actions to interact with Excel
and update the ANSYS Workbench project. This function is connected to the CLICK event of the Excel
button on line 58 of this script.

Lines 17-20
Specific cells of interest in the Workbook are created as named references in the script to facilitate later
use of these cells. In this instance, the cells that hold the values of the two input parameters and one output
parameter are given named references.

Lines 22-25
References to the three parameters exposed by the Static Structural system are also assigned to variables
for later use.

Lines 27-29
The Expression property defining the input parameters are set based on the values of the associated cells
in the Excel Workbook. Note the 'Value2' property is used because it has simpler interaction when working
with a single cell value.

Lines 31-32
The script sets the value of the output parameter cell in the workbook to 'Updating...' while calculation
proceeds.

Line 35
The Update() command is executed to update the project based on the new input parameter values.

Lines 37-40
When the Update is complete, we update the output cell value in the Workbook with the parameter value
in the Project.

Note the reference to defparam.Value. The Value property of a parameter can have different
types (Numeric, String, Boolean, Quantity, etc.). In this instance, it is a Quantity, which in turn has
properties for its Value and Unit. For consistency, we can access the value in a specific unit system
(independent of the Project unit system). So, in this case, we access the result value in "m", by using
ConvertUnit method.

Lines 46-49
The lines following the UpdateHandler definition are those first executed when the script executes. The
first operation is to load the Workbench Project containing the parameterized Static Structural analysis.

Lines 51-53
Using the imported Excel namespace, we create an instance of the Excel application and make it visible.

Lines 54-55
We open the Excel workbook that contains the parameter table and 'Update' button, and get a reference
to the primary (active) worksheet in the book.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 43
Using Scripting in ANSYS Workbench

Lines 57-59
We get a reference to the named OLE button (CommandButton1) that is present in the worksheet. This
button was added to the worksheet by inserting the control within Excel, but no other macros or code
associated with this button is required in the workbook.

Line 60
The updateHandler() function is added as an event handler to the CLICK event on the command
button. Whenever the button is clicked, the associated ANSYS Workbench script function is executed.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
44 of ANSYS, Inc. and its subsidiaries and affiliates.
Known Issues and Limitations

Known Issues and Limitations

A listing of known Journaling and Scripting issues and limitations.

General
• No known issues or limitations.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 45
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
46 of ANSYS, Inc. and its subsidiaries and affiliates.
Part I: Data Containers
ACP

ACP Setup
This container holds Setup data for an instance of ACP Pre.

Data Entities
SetupDataObject
Setup cell properties of the ACP Pre component.

Properties
AllowRenumbering

Within composite assemblies, mesh and composite data are automatically renumbered in the downstream
systems to avoid overlapping indices.

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

LoadModelGeometry

Allows passing the geometry of the model to ACP as CAD Geometry.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 49
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
50 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansoft

Ansoft
This container holds data for an instance of an Ansoft analysis.

Data Entities
AnsoftSolutionEntityType
The main entity for the Solution component of Ansoft systems. This entity exposes parameters that
control how the update operation is carried out by the underlying editor.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

KeepDesktopEnginesDuringUpdateMultiDPs

Controls whether the various engine processes that the editor employs in it's solve process are kept
alive across design points when workbench is performing a multiple design point update. This controls
the memory/time tradeoff during multiple design point updates.

Type bool

Read Only No

NonGraphical

Control whether the editor is launched in non-graphical mode or with full UI.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 51
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
52 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansoft Feedback Iterator

Ansoft Feedback Iterator

This container holds data related to a two-way coupled system where Maxwell, HFSS, or Q3D is the main
upstream system.

Methods
ExecuteOneTwoWayIteration
This command executes one two-way iteration among the coupled clients of the master "Two Way
iterator" component

ResetCompletedIterations
This command rests the number of completed iterations

Data Entities
FeedbackIteratorEntity
The main FeedbackIterator entity holding information about the coupled clients etc.

Properties
CallbackPath

The callback script file

Type string

Read Only No

CompletedSolveIterations

The number of completed solve iterations

Type int

Read Only No

CurrentDeltaDPercentage

The current delta D % we have on record.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 53
Ansoft Feedback Iterator

Read Only Yes

CurrentDeltaTPercentage

The current delta T % we have on record.

Type string

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

MaxSolveIterations

The Max number of solve iterations allowed when the FBIter is working with a system that sends con-
vergence information

Type int

Read Only No

TargetDeltaDPercentage

The relative tolerance value that indicates convergence for displacement

Type double

Read Only No

TargetDeltaTPercentage

The relative tolerance value that indicates convergence for temperature

Type double

Read Only No

TotalSolveIterations

The total number of solve iterations requested by the user.

Type int

Read Only No

FeedbackIteratorTransferManagerEntity
The entity that handles the transfer data protocol for the AnsoftCADGeometry Addin container.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
54 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 55
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
56 of ANSYS, Inc. and its subsidiaries and affiliates.
AQWA

AQWA Model
This container holds Model data for an instance of AQWA.

Methods
Edit
Opens the AQWA editor to allow modification of AQWA Model data.

Exit
Exits the AQWA editor.

GetModel
Get the DataReference for the Model data entity.

Return DataReference for the Model data entity.

Type DataReference

SendCommand
Executes one or more JScript commands in the AQWA editor.

Required Arguments

Com- The command to execute in the AQWA editor.

mand
Type string

Example
To execute some arbitrary command (in this case, causing a dialog box to appear) in the AQWA editor:

model1.SendCommand(Command="WBScript.Out(\"My Text\",true);" )

If the AQWA editor is not open SendCommand will open it, run the command and then close it.
Consider calling model1.Edit()to open the editor before using SendCommand if you do not want it
to close.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 57
AQWA

Data Entities
AqwaModel
Model data entity.

Properties
AnalysisType

Entity Analysis Type setting.

Type string

Read Only Yes

AQDBDatabaseFilesWritten

Indicates if aqwa .aqdb database files have been written for this system.

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

GeometrySelected

Specifies if this data entity has Geometry data available.

Type bool

Read Only No

PhysicsType

Entity Physics Type setting.

Type string

Read Only Yes

ProjectName

The system string identifier.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
58 of ANSYS, Inc. and its subsidiaries and affiliates.
SolverType

Entity Solver Type setting.

Type string

Read Only Yes

AQWA Results
This container holds Results data for an instance of AQWA.

Methods
Edit
Opens the AQWA editor to allow modification of AQWA Setup data or viewing of the AQWA Results.

Exit
Exits the AQWA editor.

GetResults
Get the DataReference for the Results data entity.

Return DataReference for the Results data entity.

Type DataReference

SendCommand
Executes one or more JScript commands in the AQWA editor.

Required Arguments

Com- The command to execute in the AQWA editor.

mand
Type string

Example
To execute some arbitrary command (in this case, causing a dialog box to appear) in the AQWA editor:

model1.SendCommand(Command="WBScript.Out(\"My Text\",true);" )

If the AQWA editor is not open SendCommand will open it, run the command and then close it.
Consider calling model1.Edit()to open the editor before using SendCommand if you do not want it
to close.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 59
AQWA

Data Entities
AqwaResults
Results data entity.

Properties
AnalysisType

Entity Analysis Type setting.

Type string

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

PhysicsType

Entity Physics Type setting.

Type string

Read Only Yes

SolverType

Entity Solver Type setting.

Type string

Read Only Yes

AQWA Setup
This container holds Setup data for an instance of AQWA.

Methods
Edit
Opens the AQWA editor to allow modification of AQWA Setup data or viewing of the AQWA Results.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
60 of ANSYS, Inc. and its subsidiaries and affiliates.
Exit
Exits the AQWA editor.

GetSetup
Get the DataReference for the Setup data entity.

Return DataReference for the Setup data entity.

Type DataReference

SendCommand
Executes one or more JScript commands in the AQWA editor.

Required Arguments

Com- The command to execute in the AQWA editor.

mand
Type string

Example
To execute some arbitrary command (in this case, causing a dialog box to appear) in the AQWA editor:

model1.SendCommand(Command="WBScript.Out(\"My Text\",true);" )

If the AQWA editor is not open SendCommand will open it, run the command and then close it.
Consider calling model1.Edit()to open the editor before using SendCommand if you do not want it
to close.

Data Entities
AqwaSetup
Setup data entity.

Properties
AnalysisType

Entity Analysis Type setting.

Type string

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 61
AQWA

Read Only No

PhysicsType

Entity Physics Type setting.

Type string

Read Only Yes

SolverType

Entity Solver Type setting.

Type string

Read Only Yes

StaticOnly

Used to control if Hydrodynamic Diffraction analysis solve is full or hydrostatic only when run from
Workbench. If True then only Hydrostatics are solved.

Type bool

Read Only No

AQWA Solution
This container holds Solution data for an instance of AQWA.

Methods
Edit
Opens the AQWA editor to allow modification of AQWA Solution data.

Exit
Exits the AQWA editor.

GetSolution
Get the DataReference for the Solution data entity.

Return DataReference for the Solution data entity.

Type DataReference

SendCommand
Executes one or more JScript commands in the AQWA editor.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
62 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Com- The command to execute in the AQWA editor.

mand
Type string

Example
To execute some arbitrary command (in this case, causing a dialog box to appear) in the AQWA editor:

model1.SendCommand(Command="WBScript.Out(\"My Text\",true);" )

If the AQWA editor is not open SendCommand will open it, run the command and then close it.
Consider calling model1.Edit()to open the editor before using SendCommand if you do not want it
to close.

Data Entities
AqwaSolution
Solution data entity.

Properties
AnalysisType

Entity Analysis Type setting.

Type string

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

PhysicsType

Entity Physics Type setting.

Type string

Read Only Yes

SolverType

Entity Solver Type setting.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 63
AQWA

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
64 of ANSYS, Inc. and its subsidiaries and affiliates.
AUTODYN

AUTODYN Analysis
This container holds Results data for an instance of AUTODYN.

Methods
GetAutodynAnalysis
Returns a reference to an AutodynAnalysis data entity within the container.

Return A reference to the AutodynAnalysis data entity.

Type DataReference

AUTODYN Setup
This container holds Solution data for an instance of AUTODYN.

Methods
Edit
Opens the AUTODYN editor for pre-processing, solving and post-processing. If there is an input file as-
sociated with the system the editor will load that file when it opens, otherwise the editor will create a
new model.

Exit
Closes the AUTODYN editor. If there is any unsaved data in the editor it will be saved.

GetAutodynSetup
Returns a reference to an AutodynSetup data entity within the container.

Return A reference to the AutodynSetup data entity.

Type DataReference

Import
Specifies the AUTODYN input file (*.ad), to be associated with the system. The specified file is copied
to the systems working directory and registered with workbench.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 65
AUTODYN

Required Arguments

FilePath The location of the AUTODYN input file (*.ad). If the name is blank any currently associated input
file will be removed.

Type string

SetUserExecutable
Sets the location of the user created executable to be used when the editor is opened.

Required Arguments

ExecutablePath The full path and name of the executable to use when pre-processing, solving and post-
processing.

Type string

Data Entities
AutodynSetup
This holds the properties of the setup component.

Properties
Directory

The working directory for the editor.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FileName

The name of the associated input file.

Type string

Read Only No

strUserExecutable

The location of the user defined execuatable to use.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
66 of ANSYS, Inc. and its subsidiaries and affiliates.
Type string

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 67
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
68 of ANSYS, Inc. and its subsidiaries and affiliates.
CFD Results

CFD Results
This container holds Results and post-processing data for a CFD simulation.

Methods
Edit
Opens the CFD-Post editor to allow modification of Results data.

This command will open the editor only if one is not already open on this component. If this component's
editor is already open and in interactive mode, then it will be raised to the front.

Optional Arguments

Interactive Run the editor in interactive mode if True, or in no GUI mode if False.

If not specified, the editor runs in interactive mode.

Type bool

Default Value True

Exit
Exits the editor.

Any changes made in this editor will be retained on exit. These changes are made permanent by a
Project Save, and will be discarded in the event of closing the project without saving.

If no editor is open on the component in question, this command will have no effect.

GetCFDResults
Returns the Data Entity which contains user settings and properties for the Results container.

Return The Data Entity containing settings for this component.

Type DataReference

SendCommand
Sends commands to the editor for this component using CFX Command Language (CCL) syntax. If the
editor for this component is not open, it will be launched before the commands are sent and sub-

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 69
CFD Results

sequently closed. In this mode, component data is loaded and saved as if calling Edit(Interactive=False)
and Exit around the SendCommand invocation.

The instructions must be CFX Command Language session commands that are valid for the editor in
question.

Required Arguments

Com- Valid CFX Command Language (CCL) commands

mand
Type string

Data Entities
CFDResults
Entity which manages settings and data for the CFD Results component.

Properties
ClearState

Specifies whether the state should be cleared when the Results cell is updated. This is only used if a
report has been selected or a session script has been specified to run on update.

Type bool

Read Only No

CustomReportTemplate

Specifies the file path of the custom report template to load if LoadReport is set to 'Custom'. It is recom-
mended that the template file be located in the user_files directory of the project so that it is available
if the project is archived and moved to another system.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

GenerateReport

Specifies whether to regenerate a report during component update.

The report will be generated according to the report definition within CFD-Post. Its name and location
can be controlled by the ReportName and ReportLocationDirectory advanced user properties on this
entity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
70 of ANSYS, Inc. and its subsidiaries and affiliates.
Type bool

Read Only No

LoadReport

Report to load when Results cell is edited or updated.

Type PostReportNamesType

Read Only No

MRESLoadOptionsMsg

This property has no effect and is simply used for presentation purposes.

Type string

Read Only No

PostStateFile

CFD-Post State file location.

Do not modify this property directly.

Type DataReference

Read Only No

ReportLocationDirectory

Specifies a custom directory in which to place the report files.

This is an advanced user property to be used in conjunction with the GenerateReport and ReportName
properties. By default this property is empty, in which case the project's user_files directory is used. If
a directory path is specified, the directory must exist at the time of component update.

Type string

Read Only No

ReportName

Specifies the name of the report to be generated during component update. By default the report name
is "Report".

This is an advanced user property to be used in conjunction with the GenerateReport and ReportLoca-
tionDirectory properties.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 71
CFD Results

RunSessionScript

Specifies whether a CFD-Post session script will be run as part of the component update.

If enabled, the UpdateScriptCCL property on this entity should be set to contain the session script text.

Type bool

Read Only No

StateInitializationFile

Contains CFX Command Language script for CFD-Post, to be executed as part of the component update.
This can be used to toggle regeneration of exported data, animation files, etc. In this scenario, the script
will only need to be run when loading the results into Post at a time when the Results cell is in the
‘Unfulfilled’ state (i.e. has never been opened yet).

This is an advanced user feature, and caution should be exercised. CFD-Post session files are capable
of performing file activity and changing state in ways that are not supported in Workbench sessions.
Limit your session script to activities which will not corrupt or circumvent Workbench project data
management.

Type string

Read Only No

UpdateScriptCCL

Contains CFX Command Language script for CFD-Post, to be executed as part of the component update.
This can be used to toggle regeneration of exported data, animation files, etc.

This is an advanced user feature, and caution should be exercised. CFD-Post session files are capable
of performing file activity and changing state in ways that are not supported in Workbench sessions.
Limit your session script to activities which will not corrupt or circumvent Workbench project data
management.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
72 of ANSYS, Inc. and its subsidiaries and affiliates.
CFX

CFX Setup
This container holds Setup data for an instance of CFX-Pre.

Methods
BuildSystemCouplingParticipant
Command wrapper to build the System Coupling Participant object from XML

Return Returns a valid SystemCouplingParticipant object.

Type DataReference

Required Arguments

Xml Source Xml to build the SystemCouplingParticipant from.

Type string

Edit
Opens the CFX-Pre editor to allow modification of CFX Setup data.

This command will open the editor only if one is not already open on this component. If this component's
editor is already open and in interactive mode, then it will be raised to the front.

Optional Arguments

Interactive Run the editor in interactive mode if True, or in no GUI mode if False.

If not specified, the editor runs in interactive mode.

Type bool

Default Value True

Exit
Exits the editor.

Any changes made in this editor will be retained on exit. These changes are made permanent by a
Project Save, and will be discarded in the event of closing the project without saving.

If no editor is open on the component in question, this command will have no effect.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 73
CFX

GetCFXSetupProperties
Returns the Data Entity which contains user settings and properties for the Setup container.

Return The Data Entity containing settings for this component.

Type DataReference

Import
Imports CFX Setup data into the CFX-Pre editor from an existing CFX Case file.

The Case file's contents will be imported into a new case file within the project, managed by the Setup
component. This operation is not valid if the component already contains Setup data.

Required Arguments

FilePath Path of CFX Case File to be imported.

Type string

ReinitializeContainer
This command reinitialises the selected container, resetting the local data and using the cached initial-
isation CCL commands

SendCommand
Sends commands to the editor for this component using CFX Command Language (CCL) syntax. If the
editor for this component is not open, it will be launched before the commands are sent and sub-
sequently closed. In this mode, component data is loaded and saved as if calling Edit(Interactive=False)
and Exit around the SendCommand invocation.

The instructions must be CFX Command Language session commands that are valid for the editor in
question.

Required Arguments

Com- Valid CFX Command Language (CCL) commands

mand
Type string

SetInitCCL
Sets the initialisation commands for this component using CFX Command Language (CCL) syntax. On
setting the commands they may be applied to the editor in question using ApplyInitCCLCommand.

The instructions must be CFX Command Language session commands that are valid for the editor in
question.

Required Arguments

Com- Valid CFX Command Language (CCL) commands

mand
Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
74 of ANSYS, Inc. and its subsidiaries and affiliates.
SuppressPhysicsErrors
Suppresses physics validation errors for the current CFX Setup component.

Normally, a CFX Setup component will not permit an update to proceed while validation errors exist
in the case. However, in certain special situations, it may be that particular validation errors are tolerable
and the case should be solvable.

This command can be used on CFX Setup components to bring the component from Attention Required
to Up-to-Date, allowing the downstream Solution component to be updated.

Data Entities
CFXSetupProperties
Entity which manages settings and data for the CFX Setup component.

Properties
AllowAssemblyMeshImport

This is a beta option. Allow the user to import the assembly meshes

Type bool

Read Only No

CaseFile

CFX-Pre Case file location.

Do not modify this property directly.

Type DataReference

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

PhysicsStatus

Physics state of the CFX-Pre editor, specifying validation errors, warnings and information on the current
case.

This property is updated by CFX-Pre only.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 75
CFX

Read Only No

SolverInputExtendedFiles

Extended CFX Solver Input Files for multiconfig cases

Do not modify this property directly.

Type DataReferenceSet

Read Only No

SolverInputFile

CFX-Solver Input file location.

Do not modify this property directly.

Type DataReference

Read Only No

CFX Solution
This container holds data for a CFX Solution.

Methods
ClearOldSolutionData
Every time the solver is run for a Solution container, a new set of solution files are generated and the
old ones are kept around. This command is used to clear all solution data files from past solver runs
except for the last one.

Required Arguments

KeepReferenced If true, all old solution data will be removed. Otherwise, only data not referenced in the
latest solution will be removed.

Type bool

DisplayMonitors
Displays run history and monitors for the most recent Solution update.

CFX-Solver Manager is used for displaying monitors, and (if necessary) will be launched by executing
this command.

Edit
Open the CFX-Solver Manager editor to allow modification of the run definition for the CFX Solution
component.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
76 of ANSYS, Inc. and its subsidiaries and affiliates.
Note that CFX-SolverManager is a GUI-only component that is not scriptable. This command will not
be journaled when invoked through the GUI. For batch operations, omit this command and use SetExe-
cutionControl. If execution control is specified in the Setup component, it may be necessary to use this
command with the appropriate value for the ExecutionControlOption parameter. Alternatively, the Exe-
cutionControlOption property of the Solution component can be modified directly in the script to ensure
no execution control conflicts are detected.

Optional Arguments

ExecutionControlOption Specifies how to handle conflicts in execution control if they exist.

Default use On Execution Control

Conflict property setting
UseSetupExecutionControl Edit Run Defintion using exe-
cution control from the
Setup container
UseSetupExecutionControlAl- change On Execution Control
ways Conflict property to 'Use
Setup Cell Execution Control'
and proceed with Edit Run
Defintion
UseSolutionExecutionControl Edit Run Defintion using exe-
cution control from the
Solution container
UseSolutionExecutionContro- change On Execution Control
lAlways Conflict property to 'Use
Solution Cell Execution Con-
trol' and proceed with Edit
Run Defintion

Type ExecutionControlConflictOptions

Default Value Default

EditDefFileInCommandEditor
Opens the CFX Command Editor to allow modification of the physics in the specified CFX Results or
Solver Input file.

This command will simply launch the CCL Command Editor with the provided file path. No further
Workbench interaction with the CCL Command Editor is possible, and no further activity of this com-
ponent is journaled. Do not use this command as part of any batch workflow.

Required Arguments

FilePath Path of CFX Solver Input File, or Results File, to be edited

Type string

Exit
Exits the editor.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 77
CFX

Any changes made in this editor will be retained on exit. These changes are made permanent by a
Project Save, and will be discarded in the event of closing the project without saving.

If no editor is open on the component in question, this command will have no effect.

GetCFXSolutionProperties
Returns the Data Entity which contains user settings and properties for the Solution container.

Return The Data Entity containing settings for this component.

Type DataReference

GetComponentSettingsForRsmDpUpdate
This query is used to obtain the ComponentSettingsForRsmDpUpdate object for Journaling and
Scripting

GetSolutionSettings
This query is used to obtain the solution settings object for Journaling and Scripting

Import
Imports CFX Solution data from an existing CFX Results file.

The Results file, as well as all files associated with it (such as transient or multi-configuration files, if
they exist), will be copied into the project as the generated data for the Solution component.

This command is intended for use when no Setup has been defined. If no data has been provided to
an upstream Setup, or to any upstream Geometry or Mesh components (if they exist), then all of these
components will automatically be deleted from the system as a result of this command.

Required Arguments

FilePath Path of CFX-Solver Results file to be imported.

Type string

MarkUpToDate
Accept an interrupted Solution as Up-to-Date.

The specified Solution component should be in Interrupted state. As a result of this command, the
Solution will be marked Up-to-Date.

SetExecutionControl
Sets the CFX-Solver settings (in the form of Execution Control CCL) for a Solution component.

These settings will form the basis of a run definition for the Solution component. However, certain
settings, such as the Solver Input File, are always overridden during Update. Other settings, such as all
Initialization settings, can be overridden by the Solution component's Initialization Option property as
well by as the presence of initialization data provided by other components on the project schematic.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
78 of ANSYS, Inc. and its subsidiaries and affiliates.
The CCL argument must specify valid Execution Control CCL.

Required Arguments

CCL CFX Command Language defining Execution Control for the CFX-Solver.

Type string

SwitchToBackgroundMode
Switch the Update in progress into background mode. This will enable operations that are not allowed
during an Update in foreground mode (e.g. Project Save).

This command is not normally useful in a script. Journals may record the invocation of this command
after an Update invoke, as the result of GUI activity while the Update is in progress. However, replay of
these journals will always wait for the Update invoke to complete before invoking the next command,
rendering this step ineffectual.

Data Entities
CFXSolutionProperties
Entity which manages settings and data for the CFX Solution component.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ExecutionControlOption

Specifies how to handle conflicts in execution control between this entity and the upstream Setup cell.
It is only used if execution control has been saved in this entity and the execution control in the DEF
file, provided by the upstream Setup cell, has changed since the last run.

IssueWarning In the case of a conflict, a message is dis-

played and the process is aborted.
UseExecutionControlFromSetup In the case of a conflict, the execution control
provided in the DEF file is used.
UseExecutionControlFromSolution In the case of a conflict, the execution control
saved in the Solution container is used.

Type ExecutionControlSource

Read Only No

InitializationOption

Specifies the way a Solution will be initialized during Update.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 79
CFX

Available options:

CurrentSolutionData Initialize the solution from the current Solution

component data (if the data is present and is
appropriate).
InitialConditions Always initialize the solution from defined
initial conditions.

In cases where no existing solution data is present, this property has no effect.

The default behavior is "CurrentSolutionData"; however this default can be changed in Options->CFX-
>Default Initialization Option

Type InitializationOption

Read Only No

LoadMResOptions

Specifies how multi-configuration solution data should be treated by a Results component when opened
in CFD-Post.

This option has no effect if the Solution component does not contain a results set with multiple config-
urations.

Available options:

AllConfigsSingleCase All configurations for this set of results should

be loaded and treated as a single case.
AllConfigsSeparateCases All configurations for this set of results should
be loaded, but each configuration should be
treated as a separate case.
LastConfigOnly Only the last configuration should be loaded.

The default behavior is "LastConfigOnly".

Type MResOptions

Read Only No

ResultsFile

Current CFX-Solver Results File location.

Type DataReference

Read Only Yes

SolverArguments

Additional Solver Arguments

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
80 of ANSYS, Inc. and its subsidiaries and affiliates.
SolverPath

Path to a custom Solver Executable

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 81
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
82 of ANSYS, Inc. and its subsidiaries and affiliates.
Design Exploration

DX Direct Optimization
This container holds data for an instance of Parameter Direct Optimization.

Methods
GetModel
Get the DataReference of the Model. An exception is thrown if the entity is not found.

Return The DataReference of the Model.

Type DataReference

Example
The following example shows how the user can get a Model to change one of its properties.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
dOEModel1.DOEType = "eDOETYPE_OSFD"

Data Entities
AmoOptimization
Entity which performs and manages the DesignXplorer Optimization Method Component

Properties
Converged

Convergence state

Type bool

Read Only Yes

CrossoverProbability

Maximum Allowable Pareto Percentage

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 83
Design Exploration

CurrentParetoPercentage

Pareto Percentage

Type double

Read Only Yes

CurrentStabilityPercentage

Stability Percentage

Type double

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

MaximumNumberOfPermutations

Maximum number of permutations for discrete / manufacturable values.

Type int

Read Only Yes

MaxNumCandidates

Maximum Number of Candidates

Type int

Read Only No

MaxNumCycles

Maximum Number Of Cycles for OSFD algorithm.

Type int

Read Only No

MaxNumIterations

Maximum Number of Iterations

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
84 of ANSYS, Inc. and its subsidiaries and affiliates.
MutationProbability

Maximum Allowable Pareto Percentage

Type double

Read Only No

NumberOfEvaluations

Number of Evaluations

Type int

Read Only Yes

NumberOfFailures

Number of Failures

Type int

Read Only Yes

NumberOfInitialSamples

Number of Initial Samples

Type int

Read Only No

NumCandidates

Number of Candidates

Type int

Read Only Yes

NumIterations

Current Iteration

Type int

Read Only Yes

NumSamplesPerIter

Number of Samples Per Iteration

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 85
Design Exploration

ParetoPercentage

Maximum Allowable Pareto Percentage

Type double

Read Only No

RandomGeneratorSeed

LHS Seed

Type int

Read Only No

SampleSetSize

Size of Generated Sample Set

Type int

Read Only Yes

StabilityCriterion

Maximum Allowable Pareto Percentage

Type double

Read Only No

TypeOfInitialSampling

Type Of Initial Sampling

Type TypeOfInitialSampling

Read Only No

AsoOptimization
Entity which performs and manages the DesignXplorer Optimization Method Component

Properties
Converged

Convergence state

Type bool

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
86 of ANSYS, Inc. and its subsidiaries and affiliates.
ConvergenceTolerance

Convergence Tolerance

Type double

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

MaximumNumberOfPermutations

Maximum number of permutations for discrete / manufacturable values.

Type int

Read Only Yes

MaxNumberReductionPerIteration

Maximun Number of Domain Reduction per Iteration

Type int

Read Only No

MaxNumCandidates

Maximum Number of Candidates

Type int

Read Only No

MaxNumCycles

Maximum Number Of Cycles for OSFD algorithm.

Type int

Read Only No

MaxNumDomainReductions

Maximum Number of Domain Reductions

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 87
Design Exploration

MaxNumEvaluations

Maximum Number of Evaluations

Type int

Read Only No

NumberOfEvaluations

Number of Evaluations

Type int

Read Only Yes

NumberOfFailures

Number of Failures

Type int

Read Only Yes

NumberOfInitialSamples

Number of LHS Initial Samples.

Type int

Read Only No

NumberOfScreeningSamples

Number of Screening Samples for the Adaptive Single-Objective optimization method.

Type int

Read Only No

NumberOfStartingPoints

Number of Starting Points for the Adaptive Single-Objective optimization method.

Type int

Read Only No

NumCandidates

Number of Candidates

Type int

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
88 of ANSYS, Inc. and its subsidiaries and affiliates.
PercentageOfDomainReductions

Percentage of Domain Reductions

Type double

Read Only No

RandomGeneratorSeed

LHS Seed

Type int

Read Only No

SampleSetSize

Size of Generated Sample Set

Type int

Read Only Yes

CustomConstraintProperties
Entity which wraps and manages the external Parameter Definition for the Optimization Criterion with
an external Optimization Method

Properties
No Properties.

CustomObjectiveProperties
Entity which wraps and manages the external Objective Definition for the Optimization Criterion with
an external Optimization Method

Properties
No Properties.

CustomParameterProperties
Entity which wraps and manages the external Parameter Definition for the Input Parameter with an
external Optimization Method

Properties
No Properties.

DiscreteLevel
The data entity which describes a Discrete Level of an Input Parameter.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 89
Design Exploration

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Index

Zero-based Index of the discrete level in the list of levels of the owning parameter.

Type int

Read Only No

Value

Value of the DiscreteLevel.

Type Object

Read Only No

Methods
SetValue

Sets the value of a discrete level entity. A discrete level can have an integer value (e.g. a number if
holes, a number of turns, etc) or a string value (e.g. a material name or a geometry file name).

Required Arguments

Value Value set to the discrete level entity.

Type Object

Example
The following example shows how to retrieve a discrete level from an input parameter and then change
its value.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DiscreteInputParameter = model.GetParameter(Name="P2")
level1 = DiscreteInputParameter.GetDiscreteLevel(Name="Level 1")
level1.SetValue( Value="2500" )

InputParameter
The data entity which describes an Input Parameter in DesignXplorer.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
90 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Attribute1

First editable attribute of the distribution for an uncertainty parameter. The nature of the attribute de-
pends on the distribution type. For instance, the first attribute of a Normal distribution is the Mean
value.

Type double

Read Only No

Attribute2

Second editable attribute of the distribution for an uncertainty parameter. The nature of the attribute
depends on the distribution type. For instance, the second attribute of a Normal distribution is the
Standard Deviation value. Some distribution type do not have a second attribute.

Type double

Read Only No

ConstantValue

Constant value of the Parameter when it is disabled.

Type Object

Read Only No

CustomDefinitionList

Custom Definition List

Type List<DataReference>

Read Only No

DiscreteLevels

List of the discrete levels.

Type List<DataReference>

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 91
Design Exploration

DistributionLowerBound

Distribution lower bound of the variation range for an uncertainty Parameter.

Type double

Read Only No

DistributionType

Distribution type for an uncertainty parameter.

Type DistributionType

Read Only No

DistributionUpperBound

Distribution upper bound of the variation range for an uncertainty Parameter.

Type double

Read Only No

Enabled

True if the Parameter is enabled for the current study.

Type bool

Read Only No

Kurtosis

Kurtosis value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

LowerBound

Lower bound of the variation range for a Continuous Parameter.

Type double

Read Only No

Mean

Mean value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
92 of ANSYS, Inc. and its subsidiaries and affiliates.
Nature

Nature of the Parameter.

Type ParameterNature

Read Only No

NumberOfLevels

Number of levels if the parameter nature is Discrete, or the parameter nature is Continuous and the
UseManufacturableValues property is set to True.

Type int

Read Only Yes

Skewness

Skewness value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

StandardDeviation

Standard deviation value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

Type

Type of the Parameter, either a DesignVariable in a GDO context, or an UncertaintyVariable in a SixSigma

Analysis context.

Type SimulationType

Read Only Yes

Units

Units

Type string

Read Only Yes

UpperBound

Upper bound of the variation range for a Continuous Parameter.

Type double

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 93
Design Exploration

Read Only No

UseManufacturableValues

True to restrict the variation of the parameter to defined Manufacturable Values.

Type bool

Read Only No

Methods
AddDiscreteLevel

Adds a Discrete Level entity on a discrete input parameter. A discrete level can have an integer value
(e.g. a number of holes, a number of turns, etc) or a string value (e.g. a material name or a geometry
file name). The command has optional arguments to specify the Name of the level and its Index in the
list of levels of the parameter. By default, the new level is added to the end of the list. The various discrete
levels of an input parameter represent independent configurations of the project, processed in the order
of their creation.

Return The created entity.

Type DataReference

Required Arguments

Value The value of the discrete level. Value can be an integer or a string.

Type Object

Optional Arguments

DisplayText DisplayText of the created entity. If not specified, a default name of the form "Level [#]" is
used.

Type string

Index The position of the new level in the list of discrete levels of the parameter. Index is zero-
based. If it is not specified, the new level is appended to the list.

Type int

Default Value -1

Example
The following example shows how to add new discrete levels on a discrete input parameter. The third
level is inserted between the two others.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DiscreteInputParameter = model.GetParameter(Name="P2")
DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
94 of ANSYS, Inc. and its subsidiaries and affiliates.
AddLevels

Adds a list of levels to a continuous input parameter. Each level is a quantity or a real number corres-
ponding to a manufacturable value. The list of levels forms a restriction filter used when post-processing
the input parameter. If levels are added outside of the variation range, the lower and upper bounds
are adjusted accordingly.

Required Arguments

Levels List of added levels.

Type List<string>

Optional Arguments

Overwrite True in order to overwrite the existing levels, False by default.

Type bool

Example
The following example shows how to overwrite the manufacturable values of an input parameter and how
to define an additional value later.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
InputParameter = model.GetParameter(Name="P1")
InputParameter.UseManufacturableValues = True
InputParameter.AddLevels(Levels=["0.3 [mm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
InputParameter.AddLevels(Levels="7 [mm]")

CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter The parameter on which the criterion is created.

Type DataReference

Example
The following example shows how to create an OptimizationCriterion entity.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameter1 = model.GetParameter(Name="P1")
optimizationCriterion = parameter1.CreateOptimizationCriterion()

DeleteDiscreteLevels

Deletes a list of levels from a discrete input parameter.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 95
Design Exploration

Required Arguments

DiscreteLevels List of the DiscreteLevel entities to delete.

Type List<DataReference>

Example
The following example shows how to add and then delete one or more levels from a discrete input para-
meter.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DiscreteInputParameter = model.GetParameter(Name="P1")
level1 = DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
level2 = DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
level3 = DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")
DiscreteInputParameter.DeleteDiscreteLevels(DiscreteLevels=[level1, level2])

DeleteLevels

Deletes a list of levels from a continuous input parameter.

Required Arguments

Indices Indices of the items to remove from the levels list

Type List<int>

Example
The following example shows how to add and then delete one or more levels from a continuous input
parameter for which the UseManufacturableValues property is set to True.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
InputParameter = model.GetParameter(Name="P1")
InputParameter.UseManufacturableValues = True
InputParameter.AddLevels(Levels=["0.3 [mmm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
InputParameter.DeleteLevels( Indices=[0, 1] )

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
96 of ANSYS, Inc. and its subsidiaries and affiliates.
 Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

GetCustomParameterDefinition

Get the DataReference of a CustomParameterProperties entity associated with an Input Parameter. An

exception is thrown if the entity is not found.

Return The DataReference of the CustomParameterProperties.

Type DataReference

Required Arguments

ExtensionName Extension's Name.

Type string

Example
The following example shows how the user can get a CustomParameterProperties.

system1 = GetSystem(Name="DOP")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
inputParameter1 = optimizationModel1.GetParameter(Name="P1")
customParameterDefinition1 = inputParameter1.GetCustomParameterDefinition(ExtensionName="UncertaintyParamet
customParameterDefinition1.Distribution = "Triangular"

GetDiscreteLevel

Get a discrete level by name from an input parameter. The parameter's full and ordered list of discrete
levels is available as its "DiscreteLevels" property.

Return The DataReference of the discrete level entity.

Type DataReference

Required Arguments

Name The name of the discrete level.

Type string

Example
The following example shows how the user can retrieve a discrete level of a discrete input parameter by
its name.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 97
Design Exploration

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
DiscreteInputParameter1 = dOEModel1.GetParameter(Name="P1")
level = DiscreteInputParameter1.GetDiscreteLevel(Name="Level 1")

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown
if the entity is not found.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter Parent Parameter.

Type DataReference

Example
The following example shows how the user can get a OptimizationCriterion to change one of its properties.

system1 = GetSystem(Name="RSO")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
parameter3 = optimizationModel1.GetParameter(Name="P3")
optimizationCriterion = parameter3.GetOptimizationCriterion()
optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return The DataReference of the ParameterStatistics entity.

Type DataReference

Example
The following example shows how the user can get a ParameterStatistics entity and examine its Mean
property.

system1 = GetSystem(Name="SSA")
sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
parameter4 = sixSigmaModel1.GetParameter(Name="P4")
parameterStatistics1 = parameter4.GetParameterStatistics()
mean = parameterStatistics1.Mean

MisqpOptimization
Entity which performs and manages the DesignXplorer Optimization Method Component

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
98 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Converged

Convergence state

Type bool

Read Only Yes

DerivativeApproximationType

DerivativeApproximationType

Type DerivativeApproximationType

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

InitialFiniteDifferenceDelta

Relative Gradient Step

Type double

Read Only No

MaxConvPercentage

Allowable Convergence Percentage

Type double

Read Only No

MaximumNumberOfPermutations

Maximum number of permutations for discrete / manufacturable values.

Type int

Read Only Yes

MaxNumCandidates

Maximum Number of Candidates

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 99
Design Exploration

Read Only No

MaxNumIterations

Maximum Number of Iterations

Type int

Read Only No

NumberOfEvaluations

Number of Evaluations

Type int

Read Only Yes

NumberOfFailures

Number of Failures

Type int

Read Only Yes

NumCandidates

Number of Candidates

Type int

Read Only Yes

NumIterations

Current Iteration

Type int

Read Only Yes

SampleSetSize

Size of Generated Sample Set

Type int

Read Only Yes

MOGAOptimization
Entity which performs and manages the DesignXplorer Optimization Method Component

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
100 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Converged

Convergence state

Type bool

Read Only Yes

CrossoverProbability

Maximum Allowable Pareto Percentage

Type double

Read Only No

CurrentParetoPercentage

Pareto Percentage

Type double

Read Only Yes

CurrentStabilityPercentage

Stability Percentage

Type double

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

MaximumNumberOfPermutations

Maximum number of permutations for discrete / manufacturable values.

Type int

Read Only Yes

MaxNumCandidates

Maximum Number of Candidates

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 101
Design Exploration

Read Only No

MaxNumCycles

Maximum Number Of Cycles for OSFD algorithm.

Type int

Read Only No

MaxNumIterations

Maximum Number of Iterations

Type int

Read Only No

MutationProbability

Maximum Allowable Pareto Percentage

Type double

Read Only No

NumberOfEvaluations

Number of Evaluations

Type int

Read Only Yes

NumberOfFailures

Number of Failures

Type int

Read Only Yes

NumberOfInitialSamples

Number of Initial Samples.

Type int

Read Only No

NumCandidates

Number of Candidates

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
102 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only Yes

NumIterations

Current Iteration

Type int

Read Only Yes

NumSamplesPerIter

Number of Samples Per Iteration

Type int

Read Only No

ParetoPercentage

Maximum Allowable Pareto Percentage

Type double

Read Only No

RandomGeneratorSeed

LHS Seed

Type int

Read Only No

SampleSetSize

Size of Generated Sample Set

Type int

Read Only Yes

StabilityCriterion

Stability Criterion

Type double

Read Only No

TypeOfInitialSampling

Type Of Initial Sampling

Type TypeOfInitialSampling

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 103
Design Exploration

Read Only No

NlpqlOptimization
Entity which performs and manages the DesignXplorer Optimization Method Component

Properties
Converged

Convergence state

Type bool

Read Only Yes

DerivativeApproximationType

DerivativeApproximationType

Type DerivativeApproximationType

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

InitialFiniteDifferenceDelta

Relative Gradient Step

Type double

Read Only No

MaxConvPercentage

Allowable Convergence Percentage

Type double

Read Only No

MaximumNumberOfPermutations

Maximum number of permutations for discrete / manufacturable values.

Type int

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
104 of ANSYS, Inc. and its subsidiaries and affiliates.
MaxNumCandidates

Maximum Number of Candidates

Type int

Read Only No

MaxNumIterations

Maximum Number of Iterations

Type int

Read Only No

NumberOfEvaluations

Number of Evaluations

Type int

Read Only Yes

NumberOfFailures

Number of Failures

Type int

Read Only Yes

NumCandidates

Number of Candidates

Type int

Read Only Yes

NumIterations

Current Iteration

Type int

Read Only Yes

SampleSetSize

Size of Generated Sample Set

Type int

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 105
Design Exploration

OptimizationCriterion
The data entity which describes the objective and constraint associated with a Parameter for an Optim-
ization Study.

Properties
ConstraintFirstValue

Constraint First Value used when ConstraintType is eGI_LessThanTarget, eGI_GreaterThanTarget,

eGI_NearTarget or eGI_InsideBounds.

Type double

Read Only No

ConstraintHandling

Constraint Handling

Type ConstraintHandlingType

Read Only No

ConstraintImportance

Importance of the constraint when multiple objectives are defined.

Type ImportanceLevel

Read Only No

ConstraintSecondValue

Constraint Second Value used when ConstraintType is eGI_InsideBounds.

Type double

Read Only No

ConstraintType

Constraint type for the Parameter to be optimized.

Type ConstraintType

Read Only No

CustomConstraintDefinitionList

List of custom constraint definitions.

Type List<DataReference>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
106 of ANSYS, Inc. and its subsidiaries and affiliates.
CustomObjectiveDefinitionList

List of custom objective definitions.

Type List<DataReference>

Read Only No

HistoryChart

DataReference of the associated history chart entity.

Type DataReference

Read Only No

LowerBound

Lower Bound of the variation range if Parameter is an input parameter.

Type double

Read Only No

ObjectiveImportance

Importance of the objective when multiple objectives are defined.

Type ImportanceLevel

Read Only No

ObjectiveTargetValue

Objective Target Value if ObjectiveType is SeekTarget.

Type double

Read Only No

ObjectiveType

Objective type for the Parameter to be optimized.

Type GoalType

Read Only No

StartingValue

The value of the parameter in the starting point if Parameter is an input parameter and the optimization
method uses a starting point.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 107
Design Exploration

Units

Unit of the Parameter.

Type string

Read Only Yes

UpperBound

Upper Bound of the variation range if Parameter is an input parameter.

Type double

Read Only No

Methods
GetChart

Get the DataReference of the HistoryChart associated with an OptimizationCriterion. An exception is

thrown if the entity is not found.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Example
The following example shows how the user can get a HistoryChart to export its data as .csv file.

system = GetSystem(Name="RSO")
optimization = system.GetContainer(ComponentName="Optimization")
optimizationModel = optimization.GetModel()
parameter = optimizationModel.GetParameter(Name="P3")
criterion = parameter.GetOptimizationCriterion()
historyChart = criterion.GetChart()
historyChart.ExportData(FileName="D:/Temp/HistoryChart.csv")

GetCustomConstraintDefinition

Get the DataReference of a CustomConstraintProperties entity associated with an Optimization Criterion.

An exception is thrown if the entity is not found.

Return The DataReference of the CustomConstraintProperties.

Type DataReference

Required Arguments

ExtensionName Extension's Name.

Type string

Example
The following example shows how the user can get a CustomConstraintProperties.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
108 of ANSYS, Inc. and its subsidiaries and affiliates.
 system1 = GetSystem(Name="DOP")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
outputParameter1 = optimizationModel1.GetParameter(Name="P4")
optimizationCriterion1 = outputParameter1.CreateOptimizationCriterion()
customConstraintDefinition1 = optimizationCriterion1.GetCustomConstraintDefinition(ExtensionName="CommonCon
customConstraintDefinition1.FeasibleTolerance = 0.02

GetCustomObjectiveDefinition

Get the DataReference of a CustomObjectiveProperties entity associated with an Optimization Criterion.

An exception is thrown if the entity is not found.

Return The DataReference of the CustomObjectiveProperties.

Type DataReference

Required Arguments

ExtensionName Extension's Name.

Type string

Example
The following example shows how the user can get a CustomObjectiveProperties.

system1 = GetSystem(Name="DOP")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
outputParameter1 = optimizationModel1.GetParameter(Name="P4")
optimizationCriterion1 = outputParameter1.CreateOptimizationCriterion()
customObjectiveDefinition1 = optimizationCriterion1.GetCustomObjectiveDefinition(ExtensionName="CommonObjec
customObjectiveDefinition1.RelativeObjectiveWeight = 0.9

OptimizationMethod
Entity which wraps and manages the external Optimization Method for the Optimization component

Properties
No Properties.

OptimizationModel
Entity which performs and manages the DesignXplorer Optimization Component

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 109
Design Exploration

ExportDesignPoints

If True and PreserveDesignPoints is True as well, export project for each preserved Design Point.

Type bool

Read Only No

Method

Optimization Method

Type DataReference

Read Only No

MethodName

Type of the optimization

Type string

Read Only No

NumberOfRetries

Indicates the number of times DX will try to update the failed design points.

Type int

Read Only No

PreserveDesignPoints

If True, preserve the Design Points at the project level after the component Update.

Type bool

Read Only No

RetainDesignPoints

If True and PreserveDesignPoints is True as well, retain data for each preserved Design Point.

Type bool

Read Only No

RetryDelay

Indicates how much time will elapse between tries. This option is only applicable when NumberOfRetries
is greater than 0, otherwise it has no effect.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
110 of ANSYS, Inc. and its subsidiaries and affiliates.
VerifyCandidatePoints

If True, verifies the candidates by a design points update.

Type bool

Read Only No

Methods
CreateChart

Creates a Chart entity. The chart must be updated once after its creation by invoking its Update method.
Then changes to its properties will update the chart automatically.

Return The DataReference of the Chart.

Type DataReference

Required Arguments

ChartType Type of chart to be created. The possible values depend on the type of Model. For instance, a
ResponseSurface model accepts Spider, LocalSensitivity and Response chart while a Correla-
tionModel accepts CorrelationMatrix, DeterminationMatrix and CorrelationScatter charts.

Type ChartType

Optional Arguments

DisplayText Displayed name of the chart. If not specified, a default name is applied, depending on the
value of ChartType.

Type string

Example
The following example shows how to create a chart.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
TradeoffChart = model.CreateChart(ChartType="eChartTradeoff")
TradeoffChart.Update()

CreateCustomCandidatePoint

Creates a custom candidate point. The Expressions dictionary can be used to specify a value or a
quantity for some or all of the input parameters. In the context of a response surface based optimization,
the output values are evaluated from the response surface.

Return The created entity.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 111
Design Exploration

Optional Arguments

DisplayText DisplayText of the created entity. If not specified, a default name of the form "Custom Can-
didate Point [#]" is used.

Type string

Expressions The values for each input parameter. If not specified, each parameter is initialized to its
current value.

Type IDictionary<DataReference, Object>

Example
The following example shows how to create a CustomCandidatePoint entity on an Optimization model
based on a ResponseSurface.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
inputParameter1 = model.GetParameter(Name="P1")
inputParameter2 = model.GetParameter(Name="P2")
customCandidatePoint = model.CreateCustomCandidatePoint( DisplayText="Existing Design",
Expressions={inputParameter1: "2.01", inputParameter2: "15.5"})

CreateParameterRelationship

Creates a Parameter Relationship

Return The DataReference of the ParameterRelationship.

Type DataReference

Optional Arguments

LeftExpression Left Expression.

Type string

RightExpression Right Expression.

Type string

Type Parameter Relationship Type.

Type ParameterRelationshipType

Default Value ePRT_LessThanOrEqualTo

Example
The following example shows how to create an ParameterRelationship entity.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameterRelationship = model.CreateParameterRelationship(LeftExpression="P1+P2",RightExpression="P3",Type=
parameterRelationship2 = model.CreateParameterRelationship(LeftExpression="P4+P5",RightExpression="10[inch]

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
112 of ANSYS, Inc. and its subsidiaries and affiliates.
DeleteCharts

Deletes a list of Chart entities.

Required Arguments

Charts List of Chart entities to delete.

Type List<DataReference>

Example
The following example shows how to delete existing charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart1 = model.GetChart(Name="TradeoffChart 1")
chart2 = model.GetChart(Name="SamplesChart 1")
model.DeleteCharts(Charts=[chart1, chart2])

DeleteCustomCandidatePoints

Deletes a list of CustomCandidatePoint entities.

Required Arguments

CustomCandidatePoints CustomCandidatePoint entities to delete.

Type List<DataReference>

Example
The following example shows how to delete existing CustomCandidatePoint entities from an optimization
model.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
customCandidatePoint1 = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 1")
customCandidatePoint2 = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 2")
model.DeleteCustomCandidatePoints(CustomCandidatePoints=[customCandidatePoint1, customCandidatePoint2])

DeleteObjectives

Deletes a list of OptimizationCriterion entities.

Required Arguments

OptimizationCriteria List of Objective entities to delete.

Type List<DataReference>

Example
The following example shows how to delete existing OptimizationCriterion entities.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameter1 = model.GetParameter(Name="P1")
optimizationCriterion1 = parameter1.GetOptimizationCriterion()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 113
Design Exploration

parameter3 = model.GetParameter(Name="P3")
optimizationCriterion3 = parameter3.GetOptimizationCriterion()
model.DeleteOptimizationCriteria(OptimizationCriteria=[optimizationCriterion1, optimizationCriterion3])

DeleteParameterRelationships

Deletes a list of ParameterRelationship entities.

Required Arguments

ParameterRelationships DataReferences of the entities to delete

Type List<DataReference>

Example
The following example shows how to delete existing ParameterRelationships.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
pr1 = model.GetParameterRelationship(Name="ParameterRelationShip 1")
pr2 = model.GetParameterRelationship(Name="ParameterRelationShip 2")
pr3 = model.GetParameterRelationship(Name="ParameterRelationShip 3")
model.DeleteParameterRelationships(ParameterRelationships=[pr1, pr2, pr3])

DuplicateChart

Duplicates a Chart entity. The chart must be updated once after its creation by invoking its Update
method. Then changes to its properties will update the chart automatically.

Return The DataReference of the Chart.

Type DataReference

Required Arguments

Chart The source chart to duplicate.

Type DataReference

Optional Arguments

DisplayText Displayed name of the chart. If not specified, a default name is applied, depending
on the value of ChartType.

Type string

TargetModel The model on which the duplicated chart is created. If this parameter is not set,
the model of the source chart is used.

Type DataReference

TargetResponsePoint Parent TargetResponsePoint of the chart. If this parameter is not set, the response
point of the source chart is used if applicable.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
114 of ANSYS, Inc. and its subsidiaries and affiliates.
Example
The following example shows how to duplicate a chart.

designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")

dOEModel1 = designofExperiment1.GetModel()
designPointsCurvesChart1 = dOEModel1.GetChart(Name="DesignPointsCurves")
chart1 = dOEModel1.DuplicateChart(Chart=designPointsCurvesChart1)
chart1.Update()

ExportData

Export the data of model's entities to a csv file. These entities can be candidate points, custom candidate
points, charts, parametric tables or input parameters.

Required Arguments

Entities An optional list of entities containing data to be exported in the same file.

Type List<DataReference>

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the candidate points of an optimization component.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidates = model.GetCandidatePoints()
model.ExportData(FileName="doe.csv", Entities=candidates)

GetCandidatePoint

Get the DataReference of a CandidatePoint entity. An exception is thrown if the entity is not found.

Return The DataReference of the CandidatePoint entity.

Type DataReference

Required Arguments

Name Name of the CandidatePoint to retrieve.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 115
Design Exploration

Example
The following example shows how to retrieve an existing CandidatePoint entity.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")

GetCandidatePoints

Get the DataReferenceSet of all of the existing CandidatePoint entities on the model.

Return The DataReferenceSet of the CandidatePoint entities.

Type DataReferenceSet

Example
The following example shows how to retrieve the candidate points of an optimization model.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoints = model.GetCandidatePoints()

GetChart

Query to return the chart reference for a given model and chart name.

Return The DataReference of the chart.

Type DataReference

Required Arguments

Name Name of the chart.

Type string

GetConvergenceChart

Query to return the chart reference for a given model and chart name.

Return The DataReference of the chart.

Type DataReference

GetCustomCandidatePoint

Get the DataReference of a CustomCandidatePoint entity. An exception is thrown if the entity is not
found.

Return The DataReference of the CustomCandidatePoint entity.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
116 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name Name of the CustomCandidatePoint to retrieve.

Type string

Example
The following example shows how to retrieve an existing CustomCandidatePoint entity.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
customCandidatePoint = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 1")

GetCustomCandidatePoints

Get the DataReferenceSet of all of the existing CustomCandidatePoint entities of the model.

Return The DataReferenceSet of the CustomCandidatePoint entities.

Type DataReferenceSet

Example
The following example shows how to retrieve the custom candidate points of an optimization model.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
customCandidatePoints = model.GetCustomCandidatePoints()

GetOptimizationCriteria

Get the DataReferenceSet of all of the existing OptimizationCriterion entities of the model.

Return The DataReference of the OptimizationCriterion entities.

Type DataReferenceSet

Required Arguments

Model Parent Optimization model

Type DataReference

Example
The following example shows how to retrieve the objectives of an optimization model, as a set of Optim-
izationCriterion entities.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
criteria = model.GetOptimizationCriteria()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 117
Design Exploration

GetParameter

Get the DataReference of a Parameter. An exception is thrown if the entity is not found.

Return The DataReference of the Parameter.

Type DataReference

Required Arguments

Name Name of the Parameter.

Type string

Example
The following example shows how the user can get a parameter of a model to change one of its properties.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
inputParameter1 = dOEModel1.GetParameter(Name="P1")
inputParameter1.LowerBound = 1

GetParameterRelationship

Get the DataReference of a ParameterRelationship entity. An exception is thrown if the entity is not
found.

Return The DataReference of the ParameterRelationship entity.

Type DataReference

Required Arguments

Name Name of the ParameterRelationship to retrieve.

Type string

Example
The following example shows how the user can retrieve an existing ParameterRelationship entity.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameterRelationship = model.GetParameterRelationship(Name="ParameterRelationShip 1")

GetParameterRelationships

Get the Parameter Relationships associated to a Model. If the optional argument Enabled is not specified,
the query returns all Parameter Relationships. If it is specified and True, the query returns only enabled
Parameter Relationships. If it is False, the query returns only disabled Parameter Relationships.

Return The DataReferenceSet of the ParameterRelationship entities.

Type DataReferenceSet

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
118 of ANSYS, Inc. and its subsidiaries and affiliates.
Optional Arguments

Enabled If True, the query returns only enabled Parameter Relationships. If False, the query returns only
disabled Parameter Relationships. If the argument is ommitted, the query returns all Parameter
Relationships.

Type bool

Example
The following example shows how the user can retrieve all the Parameter Relationships defined on a
model.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
allParameterRelationships = model.GetParameterRelationships()
enabledParameterRelationships = model.GetParameterRelationships(Enabled="True")
disabledParameterRelationships = model.GetParameterRelationships(Enabled="False")

GetParameters

Get the DataReferences of the InputParameter and OutputParameter of the model. If the optional argu-
ment InputParameters is not specified, the query returns all parameters. If it is specified and True, the
query returns only input parameters. If it is False, the query returns only output parameters.

Return The DataReferences of the Parameters

Type DataReferenceSet

Optional Arguments

InputParameters If True, the query returns only input parameters. If False, the query returns only output
parameters. If the argument is ommitted, the query returns all parameters.

Type bool

Example
The following example shows how the user can get the parameters of a model.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parameters = dOEModel1.GetParameters()

GetParametricTable

Get the DataReference of ParametricTable. An exception is thrown if the entity is not found. Names of
the tables generated internally are: "DesignPoints", "CorrelationMatrix", "CorrelationScatter", "MinDesign-
Points", "MaxDesignPoints", "ResponsePoints", "DeterminationMatrix".

Return The DataReference of the ParametricTable

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 119
Design Exploration

Required Arguments

Name Name of the ParametricTable

Type string

Example
The following example shows how the user can get a ParametricTable to add a new row and set values.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
parametricTable.AddRow()
parametricTable.SetCellValue(RowIndex=9,ColumnIndex=0,Value="2.1")

SetVariationReferencePoint

Sets a point as the reference to calculate the variation of the parameters in each of the candidate and
custom candidate points of the container. The variation is calculated by the command and can be re-
trieved for each parameter of each point.

Required Arguments

Point Point entity to set as the reference point.

Type DataReference

Optional Arguments

Source The source of the output values to set as the reference.

Type OutputSource

Default Value Simulation

Example
The following example shows how to set a custom candidate point as the reference and how to retrieve
the calculated variation on the parameters of a second candidate point.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
customCandidatePoint = model.GetCustomCandidatePoint(Name="CustomCandidatePoint")
model.SetVariationReferencePoint(Point=customCandidatePoint, Source="Simulation")
bestCandidate = model.GetCandidatePoint(Name="CandidatePoint")
variationOfOutputsAsDecimals = bestCandidate.GetOutputValues(Source="Simulation", ValueType="VariationToRef

VerifyPoints

Verify the CandidatePoint entities by performing a design point update to generate Simulation output
values, so that they can be compared to the ResponseSurface output values. This command has no effect
if the optimization model is used as part of a Direct Optimization system.

Required Arguments

Points List of points to verify.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
120 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type List<DataReference>

Optional Arguments

PullFromCacheOnly If True, the command attempts to pull output values from the design point cache
but does not trigger any design point update.

Type bool

Default Value False

Example
The following example shows how the user can verify all the candidate points generated by the optimization
model and extract the existing output parameter values from the first candidate point.

system1 = GetSystem(Name="RSO")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoints = model.GetCandidatePoints()
model.VerifyPoints(Points=candidatePoints)
responseSurfaceValues = candidatePoints[0].GetOutputValues(Source="ResponseSurface")
verifiedValues = candidatePoints[0].GetOutputValues(Source="Simulation")

OutputParameter
Output parameter entity for DesignXplorer.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IgnoreForFiltering

Determines whether the parameter filtering is not applicable to the output parameter in the correlation
context.

Type bool

Read Only No

InheritFromModelSettings

Determines whether the Maximum Predicted Relative Error defined at the Model level is applicable to
the output parameter.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 121
Design Exploration

LowerBound

Minimum value extracted from existing design points and/or sample sets.

Type double

Read Only Yes

MaxPredictedRelativeError

Maximum Relative Error targeted for an output parameter when refining with the Kriging algorithm.
This is the maximum predicted relative error that is acceptable for the selected output parameter.

Type double

Read Only No

PredictedRelativeError

Current value of the Predicted Relative Error when refining with the Kriging algorithm

Type double

Read Only Yes

TransformationType

Transformation Type

Type TransformationType

Read Only No

Units

Units

Type string

Read Only Yes

UpperBound

Maximum value extracted from existing design points and/or sample sets.

Type double

Read Only Yes

Methods
CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return The DataReference of the OptimizationCriterion.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
122 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataReference

Required Arguments

Parameter The parameter on which the criterion is created.

Type DataReference

Example
The following example shows how to create an OptimizationCriterion entity.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameter1 = model.GetParameter(Name="P1")
optimizationCriterion = parameter1.CreateOptimizationCriterion()

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown
if the entity is not found.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter Parent Parameter.

Type DataReference

Example
The following example shows how the user can get a OptimizationCriterion to change one of its properties.

system1 = GetSystem(Name="RSO")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
parameter3 = optimizationModel1.GetParameter(Name="P3")
optimizationCriterion = parameter3.GetOptimizationCriterion()
optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return The DataReference of the ParameterStatistics entity.

Type DataReference

Example
The following example shows how the user can get a ParameterStatistics entity and examine its Mean
property.

system1 = GetSystem(Name="SSA")
sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 123
Design Exploration

sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
parameter4 = sixSigmaModel1.GetParameter(Name="P4")
parameterStatistics1 = parameter4.GetParameterStatistics()
mean = parameterStatistics1.Mean

ParameterRelationship
Entity which manages the calculated Statistics of a parameter for a Six-Sigma Component

Properties
Enabled

True if the Parameter is enabled for the current study.

Type bool

Read Only No

ErrorMessage

Error Message associated to the Parameter Relationship.

Type string

Read Only Yes

LeftExpression

Left Expression of Parameter Relationship.

Type string

Read Only No

LeftExpressionQuantityName

Quantity Name of Left Expression of Parameter Relationship.

Type string

Read Only No

LeftExpressionValue

Value of the left expression (as a quantity string), or an error message.

Type string

Read Only Yes

RelationshipType

Type of Parameter Relationship.

Type ParameterRelationshipType

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
124 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

RightExpression

Right Expression of Parameter Relationship.

Type string

Read Only No

RightExpressionQuantityName

Quantity Name of Right Expression of Parameter Relationship.

Type string

Read Only No

RightExpressionValue

Value of the right expression (as a quantity string), or an error message.

Type string

Read Only Yes

Methods
DuplicateParameterRelationship

Duplicates a Parameter Relationship.

Return The created entity.

Type DataReference

Optional Arguments

TargetModel The model on which the Parameter Relationship is created. If this parameter is not set, the
model of the source Parameter Relationship is used.

Type DataReference

Example
The following example shows how to duplicate a Parameter Relationship.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
pr1 = model.GetParameterRelationship(Name="ParameterRelationShip")
pr2 = pr1.DuplicateParameterRelationship()
container = system1.GetContainer(ComponentName="Optimization 1")
model2 = container.GetModel()
pr3 = pr1.DuplicateParameterRelationship(TargetModel = model2)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 125
Design Exploration

GetChart

Get the DataReference of the ParameterRelationshipChart associated with a ParameterRelationship. An

exception is thrown if the entity is not found.

Return The DataReference of the ParameterRelationshipChart.

Type DataReference

Example
The following example shows how the user can get a ParameterRelationshipChart to export its data as
.csv file.

system1 = GetSystem(Name="RSO")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
parameterRelationship1 = optimizationModel1.GetParameterRelationship(Name="ParameterRelationship")
chart1 = parameterRelationship1.GetChart()
Parameters.ExportData(Data=chart1,FileName="E:/Temp/Relationship.csv")

ParameterRelationshipChart
The data entity which describes a ParameterRelationship chart. It allows you to visualize how parameter
relationship evolves during the optimization process, depending on the optimizer.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
126 of ANSYS, Inc. and its subsidiaries and affiliates.
ScreeningOptimization
Entity which performs and manages the DesignXplorer Optimization Method Component

Properties
Converged

Convergence state

Type bool

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

MaximumNumberOfPermutations

Maximum number of permutations for discrete / manufacturable values.

Type int

Read Only Yes

MaxNumCandidates

Maximum Number of Candidates

Type int

Read Only No

NumberOfEvaluations

Number of Evaluations

Type int

Read Only Yes

NumberOfFailures

Number of Failures

Type int

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 127
Design Exploration

NumberOfSamples

Number of Samples

Type int

Read Only No

NumCandidates

Number of Candidates

Type int

Read Only Yes

SampleSetSize

Size of Generated Sample Set

Type int

Read Only Yes

DX Evaluation Container
This container holds data for an instance of the Evaluation.

Data Entities
CandidatePoint
The CandidatePoint data entity is a candidate point automatically generated by an optimization.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Methods
CanUpdate

Returns true if the entity can be updated to produce the specific source of output values. As an example,
the query will return false for Source=ResponseSurface if the candidate point was generated by a Direct
Optimization system.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
128 of ANSYS, Inc. and its subsidiaries and affiliates.
Return Results of the query telling if the Point entity can be updated to produce
the specified source of output values.

Type bool

Optional Arguments

Source Source of the output values to query for.

Type OutputSource

Default Value Simulation

Example
The following example shows how to check if a CandidatePoint entity can be updated and how to update
it to obtain the Simulation output values.

system1 = GetSystem(Name="RSO")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
if candidatePoint.CanUpdate(Source="Simulation"):
candidatePoint.Update(Source="Simulation")

GetInputValues

Get the values of the input parameters. Depending on the parameter definition, each value can be a
Quantity, a real, a string or an integer.

Return The dictionary of the input parameter values.

Type ReadOnlyDictionary<DataReference, Object>

Optional Arguments

ValueType The type of parameter value to return.

Type ParameterValueType

Default Value ActualValue

Example
The following example shows how to retrieve a candidate point and then extract its input parameter values.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
dictInputValues = candidatePoint.GetInputValues()

GetOutputValues

Get the values of the output parameters for the specified source of output values.

Return The dictionary of the output parameter values.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 129
Design Exploration

Type ReadOnlyDictionary<DataReference, Object>

Optional Arguments

Source The source of the output values to return.

Type OutputSource

Default Value Simulation

ValueType The type of parameter value to return.

Type ParameterValueType

Default Value ActualValue

Example
The following example shows how to retrieve a candidate point and then extract its output parameter
values.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
responseSurfaceOutputValues = candidatePoint.GetOutputValues(Source="ResponseSurface")
simulationOutputValues = candidatePoint.GetOutputValues(Source="Simulation")

GetState

Returns the state of the entity for the specified source of output values. A different state is available
for each source of output values.

Return State for the specified nature of output values.

Type UpdatableEntityState

Optional Arguments

Source Source of output values to query for.

Type OutputSource

Default Value Simulation

Example
The following example shows how to check the state of the Simulation's source of the output values of a
CandidatePoint entity.

system1 = GetSystem(Name="RSO")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
state = candidatePoint.GetState(Source="Simulation")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
130 of ANSYS, Inc. and its subsidiaries and affiliates.
GetValue

Get the value for a given parameter and, if the parameter is an output parameter, a given source of
output values. Depending on the parameter definition, each value can be a Quantity, a real, a string or
an integer.

Return The retrieve parameter value.

Type Object

Required Arguments

Parameter The Parameter for which the value is requested.

Type DataReference

Optional Arguments

Source If Parameter is an output parameter, the source of the output value to return.

Type OutputSource

Default Value Simulation

ValueType The type of parameter value to return.

Type ParameterValueType

Default Value ActualValue

Example
The following example shows how to retrieve a candidate point generated by the optimization model,
and then extract selected parameter values.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
inputParam1 = model.GetParameter(Name="P1")
parameterValue1 = candidatePoint.GetValue(Parameter=inputParam1)
outputParam4 = model.GetParameter(Name="P4")
parameterValue2 = candidatePoint.GetValue(Parameter=outputParam4, Source="Simulation")
print parameterValue2.Value

GetValues

Get the values of all input parameters and the values of all output parameters for the specified source
of output values. Depending on the parameter definition, each value can be a Quantity, a real, a string
or an integer.

Return The dictionary of the parameter values.

Type ReadOnlyDictionary<DataReference, Object>

Optional Arguments

Source For output parameters, the source of the output values to return.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 131
Design Exploration

Type OutputSource

Default Value Simulation

ValueType The type of parameter value to return.

Type ParameterValueType

Default Value ActualValue

Example
The following example shows how to retrieve a candidate point and then extract all of its parameter values.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
parameterValues = candidatePoint.GetValues(Source="Simulation")

Update

Updates a point entity to provide the output parameter values of the requested source. If the requested
source is ResponseSurface, the output values are generated by evaluating the response surface model,
if available. If the requested source is Simulation, the output values are generated by triggering a
DesignPoint update. This command applies to CandidatePoint and CustomCandidatePoint entities.

Return The dictionary of parameters with their values.

Type ReadOnlyDictionary<DataReference, Object>

Optional Arguments

Source Source of output values to produce. The update method depends on this parameter.

Type OutputSource

Default Value Simulation

Example
The following example shows how to update an existing candidate point to obtain Simulation output
values.

system1 = GetSystem(Name="RSO")
container = system1.GetContainer(ComponentName="Optimization")
candidate1 = container.GetCandidatePoint(Name="CandidatePoint 1")
outputValues = candidate1.Update(Source="Simulation")

CandidatesChart
The data entity which describes the Candidate Points chart. The Candidate Points chart allows you to
view different kinds of information about candidate points. It allows you specify one or more parameters
for which you want to display candidates data. Color-coding and a legend make it easy to view and
interpret samples, candidate points identified by the optimization, candidates inserted manually, and
candidates for which output values have been verified by a design point update. You can specify the

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
132 of ANSYS, Inc. and its subsidiaries and affiliates.
chart’s properties to control the visibility of each axis, feasible samples, candidates you’ve inserted
manually, and candidates with verified output values.

Properties
CandidatesColoringMethod

Coloring method used to draw the chart.

Type CandidatesColoringMethods

Read Only No

DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

ShowCandidates

If True, the candidates are displayed on the chart.

Type bool

Read Only No

ShowCustomCandidates

If True, any custom candidates are displayed on the chart.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 133
Design Exploration

ShowSamples

If True, the samples are displayed on the chart.

Type bool

Read Only No

ShowStartingPoint

If True, the starting point is displayed on the chart.

Type bool

Read Only No

ShowVerifiedCandidates

If True, any verified candidates are displayed on the chart.

Type bool

Read Only No

Methods
EnableParameters

Enable or disable a list of parameters in a chart.

Required Arguments

IsEnabled False to disable the parameters, or True (default) to enable them.

Type bool

Optional Arguments

Parameters Parameters to enable or disable, or all parameters if not specified.

Type List<DataReference>

Example
The following example shows how to disable two parameters, and then how to enable all parameters by
omitting the Parameters optional parameter. This example uses a Correlation Matrix chart. The method
also applies for other types of charts like LocalSensitivity, SpiderChart, etc.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
param1 = model.GetParam(Name="P1")
param4 = model.GetParam(Name="P4")
chart = model.GetChart(Name="Correlation Matrix 1")
chart.EnableParameters( Parameters=[param1;param4], IsEnabled=false )
chart.EnableParameters()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
134 of ANSYS, Inc. and its subsidiaries and affiliates.
ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

ConvergenceCriteriaChart
The data entity which describes an ConvergenceCriteria chart. It allows you to visualize how convergence
evolves during the optimization process, depending on the optimizer.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 135
Design Exploration

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Methods
EnableVariable

Enable or disable a variable in a chart. This command is currently limited to the CorrelationScatter chart,
where LinearTrendLine_Variable and QuadraticTrendLine_Variable are the two eligible variables, and
the ConvergenceCriteria chart.

Required Arguments

IsEnabled False to disable the variable, or True (default) to enable it.

Type bool

Optional Arguments

Variable DataReference of the variable to enable or disable.

Type DataReference

Example
The following example shows how to disable and enable a variable in a CorrelationScatter or Conver-
genceCriteria chart.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
chart = model.GetChart(Name="CorrelationScatter 1")
chart.EnableVariable( Variable=chart.LinearTrendLine_Variable, IsEnabled=false)
chart.EnableParameter( Variable=chart.QuadraticTrendLine_Variable )

EnableVariables

Enable or disable a list of variables in a chart.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
136 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

IsEnabled False to disable the variable, or True (default) to enable it.

Type bool

Optional Arguments

Variables DataReference of the variable to enable or disable.

Type List<DataReference>

Example
The following example shows how to disable two variables, and then how to enable all variables by
omitting the Parameters optional variable. This example uses a CorrelationScatter chart. The method also
applies for ConvergenceCriteria Chart.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
var1 = Graphics.GetVariableXY(Name="MyName")
chart = model.GetChart(Name="CorrelationScatter 1")
chart.EnableVariables( Variables = [var1;var2], IsEnabled=false)
chart.EnableVariable()

ConvergenceCurvesChart
The data entity which describes a Convergence Curves chart. It allows you to visualize the convergence
of an algorithm: with the steps of the convergence as X-axis and the criteria of the convergence as Y-
axis. This chart can display several curves based on the same steps of convergence.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 137
Design Exploration

Read Only No

Methods
EnableParameters

Enable or disable a list of parameters in a chart.

Required Arguments

IsEnabled False to disable the parameters, or True (default) to enable them.

Type bool

Optional Arguments

Parameters Parameters to enable or disable, or all parameters if not specified.

Type List<DataReference>

Example
The following example shows how to disable two parameters, and then how to enable all parameters by
omitting the Parameters optional parameter. This example uses a Correlation Matrix chart. The method
also applies for other types of charts like LocalSensitivity, SpiderChart, etc.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
param1 = model.GetParam(Name="P1")
param4 = model.GetParam(Name="P4")
chart = model.GetChart(Name="Correlation Matrix 1")
chart.EnableParameters( Parameters=[param1;param4], IsEnabled=false )
chart.EnableParameters()

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
138 of ANSYS, Inc. and its subsidiaries and affiliates.
 container = system1.GetContainer(ComponentName="Design of Experiment")
model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

CorrelationMatrixChart
The data entity which describes a Correlation Matrix chart. This matrix allows the user to visualize how
the input and output parameters are coupled.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 139
Design Exploration

Methods
EnableParameters

Enable or disable a list of parameters in a chart.

Required Arguments

IsEnabled False to disable the parameters, or True (default) to enable them.

Type bool

Optional Arguments

Parameters Parameters to enable or disable, or all parameters if not specified.

Type List<DataReference>

Example
The following example shows how to disable two parameters, and then how to enable all parameters by
omitting the Parameters optional parameter. This example uses a Correlation Matrix chart. The method
also applies for other types of charts like LocalSensitivity, SpiderChart, etc.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
param1 = model.GetParam(Name="P1")
param4 = model.GetParam(Name="P4")
chart = model.GetChart(Name="Correlation Matrix 1")
chart.EnableParameters( Parameters=[param1;param4], IsEnabled=false )
chart.EnableParameters()

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
140 of ANSYS, Inc. and its subsidiaries and affiliates.
 parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

CorrelationScatterChart
The data entity which describes a Correlation Scatter chart. This scatter chart allows the user to visualize
the samples used to compute the correlation for the selected parameter pair, as well as the linear and
the quadratic trend lines.

Properties
Axes

Dictionary of the parameters associated to axes.

Type Dictionary<ChartAxes, DataReference>

Read Only Yes

DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 141
Design Exploration

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

LinearTrendLine_Variable

The DataReference of the LinearTrendLine variable.

Type DataReference

Read Only No

QuadraticTrendLine_Variable

The DataReference of the QuadraticTrendLine variable.

Type DataReference

Read Only No

Methods
AssociateParameterToAxis

Associates a Parameter to the specified axis of the chart. The Parameter argument can be omitted which
means that the axis is not set.

Required Arguments

Axis Axis to modify.

Type ChartAxes

Optional Arguments

Parameter Parameter entity to be assigned to the specified axis.

Type DataReference

Example
The following example shows how to assign parameters to the axes of a DesignPointsCurves chart.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
inputParam1 = model.GetParam(Name="P1")
outputParam1 = model.GetParam(Name="P5")
outputParam2 = model.GetParam(Name="P6")
chart = model.GetChart(Name="Design Point vs Parameter 1")
chart.AssociateParameterToAxis(Parameter=inputParam1, Axis="XAxis")
chart.AssociateParameterToAxis(Parameter=outputParam1, Axis="YAxis")
chart.AssociateParameterToAxis(Parameter=outputParam2, Axis="YRightAxis")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
142 of ANSYS, Inc. and its subsidiaries and affiliates.
EnableVariable

Enable or disable a variable in a chart. This command is currently limited to the CorrelationScatter chart,
where LinearTrendLine_Variable and QuadraticTrendLine_Variable are the two eligible variables, and
the ConvergenceCriteria chart.

Required Arguments

IsEnabled False to disable the variable, or True (default) to enable it.

Type bool

Optional Arguments

Variable DataReference of the variable to enable or disable.

Type DataReference

Example
The following example shows how to disable and enable a variable in a CorrelationScatter or Conver-
genceCriteria chart.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
chart = model.GetChart(Name="CorrelationScatter 1")
chart.EnableVariable( Variable=chart.LinearTrendLine_Variable, IsEnabled=false)
chart.EnableParameter( Variable=chart.QuadraticTrendLine_Variable )

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 143
Design Exploration

chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

CustomCandidatePoint
The CustomCandidatePoint data entity is a candidate point created and edited by the user for compar-
ison with the results of an optimization.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Methods
CanUpdate

Returns true if the entity can be updated to produce the specific source of output values. As an example,
the query will return false for Source=ResponseSurface if the candidate point was generated by a Direct
Optimization system.

Return Results of the query telling if the Point entity can be updated to produce
the specified source of output values.

Type bool

Optional Arguments

Source Source of the output values to query for.

Type OutputSource

Default Value Simulation

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
144 of ANSYS, Inc. and its subsidiaries and affiliates.
Example
The following example shows how to check if a CandidatePoint entity can be updated and how to update
it to obtain the Simulation output values.

system1 = GetSystem(Name="RSO")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
if candidatePoint.CanUpdate(Source="Simulation"):
candidatePoint.Update(Source="Simulation")

GetInputValues

Get the values of the input parameters. Depending on the parameter definition, each value can be a
Quantity, a real, a string or an integer.

Return The dictionary of the input parameter values.

Type ReadOnlyDictionary<DataReference, Object>

Optional Arguments

ValueType The type of parameter value to return.

Type ParameterValueType

Default Value ActualValue

Example
The following example shows how to retrieve a candidate point and then extract its input parameter values.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
dictInputValues = candidatePoint.GetInputValues()

GetOutputValues

Get the values of the output parameters for the specified source of output values.

Return The dictionary of the output parameter values.

Type ReadOnlyDictionary<DataReference, Object>

Optional Arguments

Source The source of the output values to return.

Type OutputSource

Default Value Simulation

ValueType The type of parameter value to return.

Type ParameterValueType

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 145
Design Exploration

Default Value ActualValue

Example
The following example shows how to retrieve a candidate point and then extract its output parameter
values.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
responseSurfaceOutputValues = candidatePoint.GetOutputValues(Source="ResponseSurface")
simulationOutputValues = candidatePoint.GetOutputValues(Source="Simulation")

GetState

Returns the state of the entity for the specified source of output values. A different state is available
for each source of output values.

Return State for the specified nature of output values.

Type UpdatableEntityState

Optional Arguments

Source Source of output values to query for.

Type OutputSource

Default Value Simulation

Example
The following example shows how to check the state of the Simulation's source of the output values of a
CandidatePoint entity.

system1 = GetSystem(Name="RSO")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
state = candidatePoint.GetState(Source="Simulation")

GetValue

Get the value for a given parameter and, if the parameter is an output parameter, a given source of
output values. Depending on the parameter definition, each value can be a Quantity, a real, a string or
an integer.

Return The retrieve parameter value.

Type Object

Required Arguments

Parameter The Parameter for which the value is requested.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
146 of ANSYS, Inc. and its subsidiaries and affiliates.
Optional Arguments

Source If Parameter is an output parameter, the source of the output value to return.

Type OutputSource

Default Value Simulation

ValueType The type of parameter value to return.

Type ParameterValueType

Default Value ActualValue

Example
The following example shows how to retrieve a candidate point generated by the optimization model,
and then extract selected parameter values.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
inputParam1 = model.GetParameter(Name="P1")
parameterValue1 = candidatePoint.GetValue(Parameter=inputParam1)
outputParam4 = model.GetParameter(Name="P4")
parameterValue2 = candidatePoint.GetValue(Parameter=outputParam4, Source="Simulation")
print parameterValue2.Value

GetValues

Get the values of all input parameters and the values of all output parameters for the specified source
of output values. Depending on the parameter definition, each value can be a Quantity, a real, a string
or an integer.

Return The dictionary of the parameter values.

Type ReadOnlyDictionary<DataReference, Object>

Optional Arguments

Source For output parameters, the source of the output values to return.

Type OutputSource

Default Value Simulation

ValueType The type of parameter value to return.

Type ParameterValueType

Default Value ActualValue

Example
The following example shows how to retrieve a candidate point and then extract all of its parameter values.

system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 147
Design Exploration

model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
parameterValues = candidatePoint.GetValues(Source="Simulation")

SetParameter

Sets the expression of a parameter in a CustomCandidatePoint entity. In the context of a response

surface based optimization, the output values are updated from the response surface.

Required Arguments

Expression Assigned Expression (value or quantity).

Type Object

Parameter DataReference of the parameter.

Type DataReference

Example
The following example shows how to set the expression for one parameter in an existing custom candidate
point.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
customCandidatePoint = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 1")
inputParameter1 = model.GetParameter(Name="P1")
customCandidatePoint.SetParameter(Parameter=inputParameter1, Expression="2.01")
inputParameter2 = model.GetParameter(Name="P2")
customCandidatePoint.SetParameter(Parameter=inputParameter2, Expression="2.1 [m]")

SetParameters

Sets the expression of several parameters in a CustomCandidatePoint entity. In the context of a response
surface based optimization, the output values are updated from the response surface.

Required Arguments

Expressions Dictionary of the parameters and their assigned expressions.

Type IDictionary<DataReference, Object>

Example
The following example shows how to set the expression for several parameters in an existing custom
candidate point.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
customCandidatePoint = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 1")
inputParameter1 = model.GetParameter(Name="P1")
customCandidatePoint.SetParameter(Parameter=inputParameter1, Expression="2.01")
inputParameter2 = model.GetParameter(Name="P2")
customCandidatePoint.SetParameters(Expressions={inputParameter1: "2.01", inputParameter2: "15.5 [m]"})

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
148 of ANSYS, Inc. and its subsidiaries and affiliates.
Update

Updates a point entity to provide the output parameter values of the requested source. If the requested
source is ResponseSurface, the output values are generated by evaluating the response surface model,
if available. If the requested source is Simulation, the output values are generated by triggering a
DesignPoint update. This command applies to CandidatePoint and CustomCandidatePoint entities.

Return The dictionary of parameters with their values.

Type ReadOnlyDictionary<DataReference, Object>

Optional Arguments

Source Source of output values to produce. The update method depends on this parameter.

Type OutputSource

Default Value Simulation

Example
The following example shows how to update an existing candidate point to obtain Simulation output
values.

system1 = GetSystem(Name="RSO")
container = system1.GetContainer(ComponentName="Optimization")
candidate1 = container.GetCandidatePoint(Name="CandidatePoint 1")
outputValues = candidate1.Update(Source="Simulation")

DesignPointsCurvesChart
The data entity which describes a "Design Points vs. Parameters" chart. It provides a 2D chart with two
Y axes and two X axes to display Design Points versus Parameter and/or Parameter versus Parameter
curves.

Properties
Axes

Dictionary of the parameters associated to axes

Type Dictionary<ChartAxes, DataReference>

Read Only Yes

DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 149
Design Exploration

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Methods
AssociateParameterToAxis

Associates a Parameter to the specified axis of the chart. The Parameter argument can be omitted which
means that the axis is not set.

Required Arguments

Axis Axis to modify.

Type ChartAxes

Optional Arguments

Parameter Parameter entity to be assigned to the specified axis.

Type DataReference

Example
The following example shows how to assign parameters to the axes of a DesignPointsCurves chart.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
inputParam1 = model.GetParam(Name="P1")
outputParam1 = model.GetParam(Name="P5")
outputParam2 = model.GetParam(Name="P6")
chart = model.GetChart(Name="Design Point vs Parameter 1")
chart.AssociateParameterToAxis(Parameter=inputParam1, Axis="XAxis")
chart.AssociateParameterToAxis(Parameter=outputParam1, Axis="YAxis")
chart.AssociateParameterToAxis(Parameter=outputParam2, Axis="YRightAxis")

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
150 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

DesignPointsParallelChart
The data entity which describes a Parameters Parallel chart. It allows you to visualize the DOE matrix
using parallel Y axes to represent all of the input and output parameters on the same 2D representation,
whatever the number of parameters.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 151
Design Exploration

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Methods
EnableParameters

Enable or disable a list of parameters in a chart.

Required Arguments

IsEnabled False to disable the parameters, or True (default) to enable them.

Type bool

Optional Arguments

Parameters Parameters to enable or disable, or all parameters if not specified.

Type List<DataReference>

Example
The following example shows how to disable two parameters, and then how to enable all parameters by
omitting the Parameters optional parameter. This example uses a Correlation Matrix chart. The method
also applies for other types of charts like LocalSensitivity, SpiderChart, etc.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
param1 = model.GetParam(Name="P1")
param4 = model.GetParam(Name="P4")
chart = model.GetChart(Name="Correlation Matrix 1")
chart.EnableParameters( Parameters=[param1;param4], IsEnabled=false )
chart.EnableParameters()

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
152 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

DeterminationHistogramChart
The data entity which describes the Determination Histogram chart. It allows you to visualize the coef-
ficient of determination (linear or quadratic) of each input for an output parameter.

Properties
Axes

Dictionary of the parameters associated to axes.

Type Dictionary<ChartAxes, DataReference>

Read Only Yes

DeterminationType

Determination type, either Linear or Quadratic.

Type DeterminationCoefficientChartModes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 153
Design Exploration

Read Only No

DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FullModelR2

Full Model R2 value.

Type double

Read Only Yes

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

ThresholdR2

Threshold value of R2: the chart displays only input parameters with a coefficient of determination is
greater than thus threshold.

Type double

Read Only No

Methods
AssociateParameterToAxis

Associates a Parameter to the specified axis of the chart. The Parameter argument can be omitted which
means that the axis is not set.

Required Arguments

Axis Axis to modify.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
154 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type ChartAxes

Optional Arguments

Parameter Parameter entity to be assigned to the specified axis.

Type DataReference

Example
The following example shows how to assign parameters to the axes of a DesignPointsCurves chart.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
inputParam1 = model.GetParam(Name="P1")
outputParam1 = model.GetParam(Name="P5")
outputParam2 = model.GetParam(Name="P6")
chart = model.GetChart(Name="Design Point vs Parameter 1")
chart.AssociateParameterToAxis(Parameter=inputParam1, Axis="XAxis")
chart.AssociateParameterToAxis(Parameter=outputParam1, Axis="YAxis")
chart.AssociateParameterToAxis(Parameter=outputParam2, Axis="YRightAxis")

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 155
Design Exploration

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

DeterminationMatrixChart
The data entity which describes a Determination Matrix chart. This matrix allows you to visualize how
the input and output parameters are coupled in a quadratic regression.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Methods
EnableParameters

Enable or disable a list of parameters in a chart.

Required Arguments

IsEnabled False to disable the parameters, or True (default) to enable them.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
156 of ANSYS, Inc. and its subsidiaries and affiliates.
Optional Arguments

Parameters Parameters to enable or disable, or all parameters if not specified.

Type List<DataReference>

Example
The following example shows how to disable two parameters, and then how to enable all parameters by
omitting the Parameters optional parameter. This example uses a Correlation Matrix chart. The method
also applies for other types of charts like LocalSensitivity, SpiderChart, etc.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
param1 = model.GetParam(Name="P1")
param4 = model.GetParam(Name="P4")
chart = model.GetChart(Name="Correlation Matrix 1")
chart.EnableParameters( Parameters=[param1;param4], IsEnabled=false )
chart.EnableParameters()

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 157
Design Exploration

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

DistributionChart
The entity which describes a parameter's Distribution chart. This chart is always associated with an un-
certainty parameter and allows you to visualize the statistical distribution defined or calculated for this
parameter.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Parameter

The parameter entity associated with the chart.

Type DataReference

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
158 of ANSYS, Inc. and its subsidiaries and affiliates.
Methods
ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

GoodnessOfFit
Entity which manages the Goodness Of Fit Information of a Response Surface for an Output Parameter

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 159
Design Exploration

Properties
DiscreteExpressions

A Dictionary holding the values of all discrete input. Note: Discrete parameter values are level values,
not indices.

Type Dictionary<DataReference, Object>

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Methods
CreateAdvancedReport

For the standard response surface only (Full second order Polynomials), creates an Advanced Goodness
of Fit report for any direct output parameter.

Return A string which contains the generated Advanced Goodness of Fit report.

Type string

Required Arguments

Parameter Parent Parameter of the report.

Type DataReference

Optional Arguments

PlainTextFormat Plain text formatting instead of HTML (default).

Type bool

Default Value False

Example
The following example shows how to create an Advanced Goodness of Fit report.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
160 of ANSYS, Inc. and its subsidiaries and affiliates.
 container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
gof1 = model.GetGoodnessOfFit(Name="GoodnessOfFit")
outputParameter1 = model.GetParameter(Name="P4")
report1 = gof1.CreateAdvancedReport(Parameter=outputParameter1)

SetDiscreteParameter

Sets the Expression of a discrete input parameter in a GoodnessOfFit and updates the associated output
parameter values. The chart entities depending on the GoodnessOfFit are updated as well.

Required Arguments

DiscreteParameter DataReference of the Discrete Input parameter.

Type DataReference

Expression Assigned Expression (discrete value).

Type string

Example
The following example shows how to set the expression for one discrete parameter in an existing Good-
nessOfFit.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
gof = model.GetGoodnessOfFit(Name="Goodness Of Fit")
inputParameter1 = model.GetParameter(Name="P1")
gof.SetDiscreteParameter(DiscreteParameter=inputParameter1, Expression="15")

Update

Updates the goodness of fit and the results which depend on it. If the goodness of fit is already uptodate,
nothing is done unless the Force flag is set to True.

Optional Arguments

Force Set to true if the update operation of the goodness of fit point is required even if it's already uptodate.

Type bool

Default Value False

Example
The following example shows how to update an existing GoodnessOfFit.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
gof1 = model.GetGoodnessOfFit(Name="GOF 1")
gof1.Update()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 161
Design Exploration

HistoryChart
The data entity which describes an History chart. It allows you to visualize how a parameter evolves
during the optimization process, point by point or iteration by iteration depending on the optimizer.
Defined target and constraints values are also represented.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Methods
ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
162 of ANSYS, Inc. and its subsidiaries and affiliates.
Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

LocalSensitivityChart
The data entity which describes a Local Sensitivity chart. It allows you to visualize the impact that
changing each input parameter independently has on the output parameters. A Local Sensitivity chart
accepts two different graphical modes -BarChart and PieChart- and supports enabling/disabling input
and/or output parameters. A Local Sensitivity depends on a Response Point which serves as a reference
point for sensitivity computation.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 163
Design Exploration

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Mode

Specifies the graphical representation used to render local sensitivity data. It can be either BarChart or
PieChart.

Type SensitivityChartModes

Read Only No

Methods
EnableParameters

Enable or disable a list of parameters in a chart.

Required Arguments

IsEnabled False to disable the parameters, or True (default) to enable them.

Type bool

Optional Arguments

Parameters Parameters to enable or disable, or all parameters if not specified.

Type List<DataReference>

Example
The following example shows how to disable two parameters, and then how to enable all parameters by
omitting the Parameters optional parameter. This example uses a Correlation Matrix chart. The method
also applies for other types of charts like LocalSensitivity, SpiderChart, etc.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
param1 = model.GetParam(Name="P1")
param4 = model.GetParam(Name="P4")
chart = model.GetChart(Name="Correlation Matrix 1")
chart.EnableParameters( Parameters=[param1;param4], IsEnabled=false )
chart.EnableParameters()

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
164 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

LocalSensitivityCurvesChart
The data entity which describes a Local Sensitivity Curves chart. It allows you to visualize the impact
that changing each input parameter independently has on the output parameters. It allows you to
visualize one or two output parameters at the same time. A Local Sensitivity Curves chart supports en-
abling and disabling input parameters. A Local Sensitivity Curves depends on a Response Point which
serves as a reference point for computation of the sensitivity.

Properties
Axes

Dictionary of the parameters associated to axes.

Type Dictionary<ChartAxes, DataReference>

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 165
Design Exploration

AxesRangeMode

Axes range for output parameters controls if the range is determined from the chart's data or the min-
max of outputs.

Type AxesRangeModes

Read Only No

ChartResolution

Chart resolution.

Type int

Read Only No

DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Methods
AssociateParameterToAxis

Associates a Parameter to the specified axis of the chart. The Parameter argument can be omitted which
means that the axis is not set.

Required Arguments

Axis Axis to modify.

Type ChartAxes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
166 of ANSYS, Inc. and its subsidiaries and affiliates.
Optional Arguments

Parameter Parameter entity to be assigned to the specified axis.

Type DataReference

Example
The following example shows how to assign parameters to the axes of a DesignPointsCurves chart.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
inputParam1 = model.GetParam(Name="P1")
outputParam1 = model.GetParam(Name="P5")
outputParam2 = model.GetParam(Name="P6")
chart = model.GetChart(Name="Design Point vs Parameter 1")
chart.AssociateParameterToAxis(Parameter=inputParam1, Axis="XAxis")
chart.AssociateParameterToAxis(Parameter=outputParam1, Axis="YAxis")
chart.AssociateParameterToAxis(Parameter=outputParam2, Axis="YRightAxis")

EnableParameters

Enable or disable a list of parameters in a chart.

Required Arguments

IsEnabled False to disable the parameters, or True (default) to enable them.

Type bool

Optional Arguments

Parameters Parameters to enable or disable, or all parameters if not specified.

Type List<DataReference>

Example
The following example shows how to disable two parameters, and then how to enable all parameters by
omitting the Parameters optional parameter. This example uses a Correlation Matrix chart. The method
also applies for other types of charts like LocalSensitivity, SpiderChart, etc.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
param1 = model.GetParam(Name="P1")
param4 = model.GetParam(Name="P4")
chart = model.GetChart(Name="Correlation Matrix 1")
chart.EnableParameters( Parameters=[param1;param4], IsEnabled=false )
chart.EnableParameters()

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 167
Design Exploration

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

ParameterStatistics
Entity which manages the calculated Statistics of a parameter for a Six-Sigma Component

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Entropy

Shannon Entropy value (Complexity)

Type double

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
168 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

InvProbabilityTable

DataReference of the Inverse Probability ParametricTable for the associated parameter

Type DataReference

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Kurtosis

Kurtosis value

Type double

Read Only No

Mean

Mean value

Type double

Read Only No

Parameter

DataReference of the input or output parameter associated with this statistics entity.

Type DataReference

Read Only No

ProbabilityTable

DataReference of the Probability ParametricTable for the associated parameter

Type DataReference

Read Only No

SigmaMaximum

Sigma Maximum value

Type double

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 169
Design Exploration

Read Only No

SigmaMinimum

Sigma Minimum value

Type double

Read Only No

SignalNoiseLarge

Signal-Noise Ratio value (Larger is Better)

Type double

Read Only No

SignalNoiseNominal

Signal-Noise Ratio value (Nominal is Best)

Type double

Read Only No

SignalNoiseSmall

Signal-Noise Ratio value (Smaller is Better)

Type double

Read Only No

Skewness

Skewness value

Type double

Read Only No

StandardDeviation

Standard Deviation value

Type double

Read Only No

StatisticsChart

DataReference of the statistics chart for the associated parameter

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
170 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

TableType

Type of the probability table

Type SixSigmaTableTypes

Read Only No

ParametricTable
ParametricTable entity used to encapsulate most of the evaluation results in a convenient 2D matrix
format.

Properties
DimCol

Number of columns.

Type int

Read Only Yes

DimRow

Number of rows.

Type int

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Methods
AddRow

Adds a row to the bottom of a ParametricTable entity.

Optional Arguments

RowValues New values for the row.

Type List<string>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 171
Design Exploration

Example
The following example shows how to make a DOE editable, to retrieve the table of design points and add
a new row to it.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.AddRow()

DeleteRows

Delete rows from a ParametricTable entity.

Required Arguments

Indices Indices of the rows to delete.

Type List<int>

Example
The following example shows how to delete rows from the DOEmatrix in a custom DOE context.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.DeleteRows(Indices=[0,7,8,9])

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
172 of ANSYS, Inc. and its subsidiaries and affiliates.
 chart.ExportData(FileName="doe.csv", AppendMode=True)

GetCellValue

Get the Value of a ParametricTable's cell. An exception is thrown if the entity is not found.

Return The value of the cell.

Type string

Required Arguments

ColumnIndex ColumnIndex (zero-based) of the cell.

Type int

RowIndex RowIndex (zero-based) of the cell.

Type int

Example
The following example shows how the user can get the value of the ParametricTable's cell [0,3].

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
cellValue = parametricTable.GetCellValue(RowIndex=0,ColumnIndex=3)

GetRowUpdateOrder

Get the Update Order value of a row in a ParametricTable. An exception is thrown if the entity is not
found.

Return The value of the update order.

Type double

Required Arguments

RowIndex RowIndex (zero-based) of the cell.

Type int

Example
The following example shows how to get the Update Order value of row [3] in the ParametricTable.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
updateOrderValue = parametricTable.GetRowUpdateOrder(RowIndex=3)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 173
Design Exploration

GetRowValues

Get the Values of a ParametricTable's row. An exception is thrown if the entity is not found.

Return List of the values of the specified row.

Type List<string>

Required Arguments

RowIndex RowIndex (zero-based) of the row to retrieve.

Type int

Example
The following example shows how the user can get the values of the 4th ParametricTable's row.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
rowValues = parametricTable.GetRowValues(RowIndex=3)

OptimizeUpdateOrder

Optimizes the Update Order of Design Points to minimize the number of modifications between two
consecutive Design Points. This command applies to the "DesignPoints" ParametricTable of a Design
of Experiments model or of a Response Surface in a manual refinement context. It also applies to the
"VerificationPoints" ParametricTable of a Response Surface model.

Example
The following example shows how to optimize the update order of the DesignPoints table in a Design of
Experiments model.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.OptimizeUpdateOrder()

SetCellValue

Sets the value of a ParametricTable cell. If the table is read-only, the command has no effect.

Required Arguments

ColumnIndex Zero-based column index of the cell.

Type int

RowIndex Zero-based row index of the cell.

Type int

Value New value of the cell.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
174 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Example
The following example shows how to set the value of the DesignPoints table in a custom DOE context.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.AddRow()
DOEMatrix.SetCellValue(RowIndex=0, ColumnIndex=0, Value="12.5 [mm]")

SetOutputValuesEditable

Sets the values of the output parameters as Editable (Editable=True) or Calculated (Editable=False) for
the complete table, or a set of rows specified by the RowIndices argument. This command is applicable
to the "DesignPoints" ParametricTable of a Design of Experiments model in a custom context (DOEType
is "eDOETYPE_USER" or "eDOETYPE_CUSTOM_OSFD") or of a Response Surface model in a manual re-
finement context. It also applies to the "VerificationPoints" ParametricTable of a Response Surface
model.

Required Arguments

Editable True to define output values as Editable, or False to mark output values as calculated.

Type bool

Optional Arguments

RowIndices Optional list of row zero-based indices. If this argument is not specified, the command applies
to the complete ParametricTable.

Type List<int>

Example
The following example shows how to switch a DOE model to the custom mode and then set the output
values as editable for the first three design points of the DOE matrix.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.SetOutputValuesEditable(Editable=True, RowIndices=[0,1,2])

SetRowUpdateOrder

Sets the Update Order value for a row in a ParametricTable. If the table doesn't support Update Order
functionality, the command has no effect.

Required Arguments

RowIndex Zero-based row index of the cell.

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 175
Design Exploration

UpdateOrder New value of the update order.

Type double

Example
The following example shows how to set the Update Order value of the DesignPoints table in a Design of
Experiments model.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.SetRowUpdateOrder(RowIndex=0, Value="2.0")

SetRowValues

Sets the values of a ParametricTable's row. If the table is read-only, the command has no effect.

Required Arguments

RowIndex Zero-based row index of the cell.

Type int

RowValues New values for the row.

Type List<string>

Example
The following example shows how to set the values of the DesignPoints table in a custom DOE context.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.AddRow()
DOEMatrix.SetRowValues(RowIndex=0, RowValues=[ "12.5 [mm]", "1" ] )

SetUpdateOrderByRow

Sets a value for the UpdateOrder property of all Design Points using sorting settings. This command
applies to the "DesignPoints" ParametricTable of a Design of Experiments model or of a Response Surface
in a manual refinement context. It also applies to the "VerificationPoints" ParametricTable of a Response
Surface model.

Optional Arguments

SortBy Definition of the sort.

Type List<string>

Example
The following example shows how to set the update order of the DesignPoints table in a Design of Exper-
iments model. The Design Points are sorted first by their values for the parameter P3 (in ascending order),
and then by their values for the parameter P1 (in descending order).

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
176 of ANSYS, Inc. and its subsidiaries and affiliates.
 container = system1.GetContainer(ComponentName="Design of Experiment")
model = container.GetModel()
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.SetUpdateOrderByRow(SortBy=["P3:+", "P1:-"])

UpdateRows

Updates the design points held in rows from a ParametricTable entity and the results which depend
on it.

Required Arguments

Indices Indices of the rows to update.

Type List<int>

Example
The following example shows how to update the design points from the VerificationPoints Table.

responseSurface1 = system1.GetContainer(ComponentName="Response Surface")

responseSurfaceModel1 = responseSurface1.GetModel()
parametricTable1 = responseSurfaceModel1.GetParametricTable(Name="VerificationPoints")
parametricTable1.UpdateRows(Indices=[0,1])

PredictedvsObservedScatterChart
The data entity which describes a PredictedvsObserved Scatter chart. This scatter chart allows the user
to visualize the predicted output values versus observed output values for all design points used to
compute the response surface.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 177
Design Exploration

Type bool

Read Only No

ShowDesignPoints

Option to display the design points.

Type bool

Read Only No

ShowVerificationPoints

Option to display the verification points.

Type bool

Read Only No

Methods
EnableParameters

Enable or disable a list of parameters in a chart.

Required Arguments

IsEnabled False to disable the parameters, or True (default) to enable them.

Type bool

Optional Arguments

Parameters Parameters to enable or disable, or all parameters if not specified.

Type List<DataReference>

Example
The following example shows how to disable two parameters, and then how to enable all parameters by
omitting the Parameters optional parameter. This example uses a Correlation Matrix chart. The method
also applies for other types of charts like LocalSensitivity, SpiderChart, etc.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
param1 = model.GetParam(Name="P1")
param4 = model.GetParam(Name="P4")
chart = model.GetChart(Name="Correlation Matrix 1")
chart.EnableParameters( Parameters=[param1;param4], IsEnabled=false )
chart.EnableParameters()

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
178 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

ResponseChart
The data entity which describes a Response chart. It allows you to visualize the impact that changing
each input parameter has on the selected output parameter. It has three Modes - 2D, 3D and 2DSlices
- allowing you to vary one or two input parameters at the same time. A Response depends on a Response
Point which serves as a reference point for non-varying input parameters.

Properties
Axes

Dictionary of the parameters associated to axes

Type Dictionary<ChartAxes, DataReference>

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 179
Design Exploration

ChartResolutionAlongX

Chart resolution along the X axis.

Type int

Read Only No

ChartResolutionAlongY

Chart resolution along the Y axis.

Type int

Read Only No

DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Mode

Response chart mode: 2D, 3D or 2D Slices.

Type ResponseChartModes

Read Only No

NumberOfSlices

Number of slices for the 2D Slices mode.

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
180 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

ShowDesignPoints

Option to display the design points of the DOE and the refinement points.

Type bool

Read Only No

Methods
AssociateParameterToAxis

Associates a Parameter to the specified axis of the chart. The Parameter argument can be omitted which
means that the axis is not set.

Required Arguments

Axis Axis to modify.

Type ChartAxes

Optional Arguments

Parameter Parameter entity to be assigned to the specified axis.

Type DataReference

Example
The following example shows how to assign parameters to the axes of a DesignPointsCurves chart.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
inputParam1 = model.GetParam(Name="P1")
outputParam1 = model.GetParam(Name="P5")
outputParam2 = model.GetParam(Name="P6")
chart = model.GetChart(Name="Design Point vs Parameter 1")
chart.AssociateParameterToAxis(Parameter=inputParam1, Axis="XAxis")
chart.AssociateParameterToAxis(Parameter=outputParam1, Axis="YAxis")
chart.AssociateParameterToAxis(Parameter=outputParam2, Axis="YRightAxis")

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 181
Design Exploration

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

ResponsePoint
The ResponsePoint data entity: a design point for which output values are computed from a Response
Surface.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Expressions

A Dictionary of the input parameter values defining the response point and the corresponding output
parameter values predicted from the response surface. Note that for discrete parameters and continuous
parameters using manufacturable values, the Dictionary contains the value of the level rather than its
index.

Type Dictionary<DataReference, Object>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
182 of ANSYS, Inc. and its subsidiaries and affiliates.
Note

User notes about the response point.

Type string

Read Only No

Methods
CreateChart

Creates a Chart entity attached to the Response Point. This chart is updated automatically when the
parameter values of the ResponsePoint change. It is deleted automatically when the ResponsePoint is
deleted. The chart must be updated once after its creation by invoking its Update method. Then changes
to its properties or its parent ResponsePoint will update the chart automatically.

Return The DataReference of the Chart.

Type DataReference

Required Arguments

ChartType Type of chart to be created. The possible values are "eChartLocalSensitivity", "eChartLocalSens-
itivityCurves", "eChartResponse" and "eChartSpiderResponses"

Type ChartType

Optional Arguments

DisplayText DisplayText of the chart. If not specified, a default name is applied, depending on the value
of ChartType.

Type string

Example
The following example shows how to create a ResponsePoint chart.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
responsePoint = model.GetResponsePoint(Name="Response Point 1")
spiderChart = responsePoint.CreateChart(ChartType="eChartSpiderResponses")
spiderChart.Update()

DuplicateChart

Duplicates a Chart entity attached to a Response Point. The chart must be updated once after its creation
by invoking its Update method. Then changes to its properties will update the chart automatically.

Return The DataReference of the Chart.

Type DataReference

Required Arguments

Chart The source chart to duplicate.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 183
Design Exploration

Type DataReference

Optional Arguments

DisplayText Displayed name of the chart. If not specified, a default name is applied, depending
on the value of ChartType.

Type string

TargetResponsePoint ResponsePoint on which the duplicated chart is created. If this parameter is not
set, the response point of the source chart is used.

Type DataReference

Example
The following example shows how to duplicate a chart.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
responsePoint = model.GetResponsePoint(Name="Response Point 1")
spiderChart = responsePoint.GetChart(Name="Spider")
spiderChart2 = responsePoint.DuplicateChart(Chart=spiderChart)
spiderChart2.Update()

GetChart

Get the DataReference of a Chart from a ResponsePoint. An exception is thrown if the entity is not
found.

Return The DataReference of the Chart entity.

Type DataReference

Required Arguments

Name Name of the chart

Type string

Example
The following example shows how to retrieve an existing Chart from a ResponsePoint.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
rp = model.GetResponsePoint(Name="Response Point 1")
chart = rp.GetChart(Name="SpiderChart 1")

GetCharts

Get the DataReferences of the Charts from a ResponsePoint.

Return The DataReferences of the Chart entities.

Type DataReferenceSet

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
184 of ANSYS, Inc. and its subsidiaries and affiliates.
Example
The following example shows how to retrieve all the charts defined for a ResponsePoint.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
rp = model.GetResponsePoint(Name="Response Point 1")
charts = rp.GetCharts()

SetDiscreteParameters

Sets the Expression of several discrete input parameters in a GoodnessOfFit and updates the associated
output parameter values. The chart depending on the GoodnessOfFit is updated as well.

Required Arguments

Expressions Dictionary of the discrete input parameters and their assigned expressions.

Type Dictionary<DataReference, string>

Example
The following example shows how to set the expression for several discrete input parameters in an existing
GoodnessOfFit.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
gof = model.GetGoodnessOfFit(Name="Goodness Of Fit 1")
inputParameter1 = model.GetParameter(Name="P1")
inputParameter2 = model.GetParameter(Name="P2")
gof.SetDiscreteParameters(Expressions={inputParameter1: "2", inputParameter2: "15"})

SetParameter

Sets the Expression of an input parameter in a ResponsePoint and updates the associated output
parameter values. If there are chart entities depending on the ResponsePoint, they are updated as well.

Required Arguments

Expression Assigned Expression (value or quantity).

Type string

Parameter DataReference of the Input parameter.

Type DataReference

Example
The following example shows how to set the expression for one parameter in an existing ResponsePoint.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
rp = model.GetResponsePoint(Name="Response Point 1")
inputParameter1 = model.GetParameter(Name="P1")
rp.SetParameter(Parameter=inputParameter1, Expression="2.01")
inputParameter2 = model.GetParameter(Name="P2")
rp.SetParameter(Parameter=inputParameter2,Expression="2.1 [m]")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 185
Design Exploration

SetParameters

Sets the Expression of several input parameters in a ResponsePoint and updates the associated output
parameter values. If there are chart entities depending on the ResponsePoint, they are updated as well.

Required Arguments

Expressions Dictionary of the input parameters and their assigned expressions.

Type Dictionary<DataReference, string>

Example
The following example shows how to set the expression for several input parameters in an existing Respon-
sePoint.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
rp = model.GetResponsePoint(Name="Response Point 1")
inputParameter1 = model.GetParameter(Name="P1")
inputParameter2 = model.GetParameter(Name="P2")
rp.SetParameters(Expressions={inputParameter1: "2.01", inputParameter2: "15.5 [m]"})

Update

Updates the response point and the results which depend on it. If the reponse point is already uptodate,
nothing is done unless the Force flag is set to True.

Optional Arguments

Force Set to true if the update operation of the response point is required even if it's already uptodate.

Type bool

Default Value False

Example
The following example shows how to update an existing ResponsePoint.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
rp = model.GetResponsePoint(Name="Response Point 1")
rp.Update()

SamplesChart
The data entity which describes the Samples chart. It allows you to explore the samples generated for
an Optimization study by using parallel Y axes to represent all of the input and output parameters on
the same 2D representation, whatever the number of parameters. It can filter the number of visible
Pareto Fronts and supports two Modes: Candidates or Pareto Fronts.

Properties
ColoringMethod

Coloring method used to draw the chart.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
186 of ANSYS, Inc. and its subsidiaries and affiliates.
Type ChartColoringMethods

Read Only No

DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Mode

Samples chart mode.

Type SamplesChartModes

Read Only No

NumberOfParetoFront

Number of Pareto fronts to display. This is used as a filter to display only the most interesting fronts,
given an optimization study.

Type uint

Read Only No

ShowInfeasiblePoints

If True, any infeasible points are displayed on the chart.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 187
Design Exploration

Methods
EnableParameters

Enable or disable a list of parameters in a chart.

Required Arguments

IsEnabled False to disable the parameters, or True (default) to enable them.

Type bool

Optional Arguments

Parameters Parameters to enable or disable, or all parameters if not specified.

Type List<DataReference>

Example
The following example shows how to disable two parameters, and then how to enable all parameters by
omitting the Parameters optional parameter. This example uses a Correlation Matrix chart. The method
also applies for other types of charts like LocalSensitivity, SpiderChart, etc.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
param1 = model.GetParam(Name="P1")
param4 = model.GetParam(Name="P4")
chart = model.GetChart(Name="Correlation Matrix 1")
chart.EnableParameters( Parameters=[param1;param4], IsEnabled=false )
chart.EnableParameters()

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
188 of ANSYS, Inc. and its subsidiaries and affiliates.
 parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

SensitivitiesChart
The data entity which describes a Sensitivities chart. It allows you to visualize the global sensitivities of
each output with respect to the input parameters. A Sensitivities chart has two different graphical modes
-BarChart and PieChart- and supports enabling/disabling input and/or output parameters.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 189
Design Exploration

Mode

Specifies the graphical representation used to render local sensitivity data. It can be either BarChart or
PieChart.

Type SensitivityChartModes

Read Only No

Methods
EnableParameters

Enable or disable a list of parameters in a chart.

Required Arguments

IsEnabled False to disable the parameters, or True (default) to enable them.

Type bool

Optional Arguments

Parameters Parameters to enable or disable, or all parameters if not specified.

Type List<DataReference>

Example
The following example shows how to disable two parameters, and then how to enable all parameters by
omitting the Parameters optional parameter. This example uses a Correlation Matrix chart. The method
also applies for other types of charts like LocalSensitivity, SpiderChart, etc.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
param1 = model.GetParam(Name="P1")
param4 = model.GetParam(Name="P4")
chart = model.GetChart(Name="Correlation Matrix 1")
chart.EnableParameters( Parameters=[param1;param4], IsEnabled=false )
chart.EnableParameters()

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
190 of ANSYS, Inc. and its subsidiaries and affiliates.
 Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

SpiderChart
The data entity which describes a Spider chart. It allows you to visualize the impact that changing the
input parameters has on all output parameters simultaneously. A Spider chart depends on a Response
Point and shows the same values as its parent Response Point.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 191
Design Exploration

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Methods
EnableParameters

Enable or disable a list of parameters in a chart.

Required Arguments

IsEnabled False to disable the parameters, or True (default) to enable them.

Type bool

Optional Arguments

Parameters Parameters to enable or disable, or all parameters if not specified.

Type List<DataReference>

Example
The following example shows how to disable two parameters, and then how to enable all parameters by
omitting the Parameters optional parameter. This example uses a Correlation Matrix chart. The method
also applies for other types of charts like LocalSensitivity, SpiderChart, etc.

container = system1.GetContainer(ComponentName="Correlation")
model = container.GetModel()
param1 = model.GetParam(Name="P1")
param4 = model.GetParam(Name="P4")
chart = model.GetChart(Name="Correlation Matrix 1")
chart.EnableParameters( Parameters=[param1;param4], IsEnabled=false )
chart.EnableParameters()

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
192 of ANSYS, Inc. and its subsidiaries and affiliates.
 Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

StatisticsChart
The StatisticsChart shows the Probability Distribution Function and Cumulative Distribution Function
results of a Six Sigma analysis

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 193
Design Exploration

Type bool

Read Only No

Methods
ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

TradeoffChart
The data entity which describes the Tradeoff chart. It allows you to visualize the samples used in an
optimization study and the Pareto fronts associated with them, if any. It supports the exploration of
the generated samples in a 2D or 3D Mode, and can filter the number of visible Pareto Fronts.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
194 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Axes

Dictionary of the parameters associated to axes.

Type Dictionary<ChartAxes, DataReference>

Read Only Yes

DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Mode

Chart mode, either 2D or 3D.

Type TradeoffChartModes

Read Only No

NumberOfParetoFront

Number of Pareto front to display. This is used as a filter to display only the most interesting fronts,
given an optimization study.

Type uint

Read Only No

ShowInfeasiblePoints

If True, any infeasible points are displayed on the chart.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 195
Design Exploration

Type bool

Read Only No

Methods
AssociateParameterToAxis

Associates a Parameter to the specified axis of the chart. The Parameter argument can be omitted which
means that the axis is not set.

Required Arguments

Axis Axis to modify.

Type ChartAxes

Optional Arguments

Parameter Parameter entity to be assigned to the specified axis.

Type DataReference

Example
The following example shows how to assign parameters to the axes of a DesignPointsCurves chart.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
inputParam1 = model.GetParam(Name="P1")
outputParam1 = model.GetParam(Name="P5")
outputParam2 = model.GetParam(Name="P6")
chart = model.GetChart(Name="Design Point vs Parameter 1")
chart.AssociateParameterToAxis(Parameter=inputParam1, Axis="XAxis")
chart.AssociateParameterToAxis(Parameter=outputParam1, Axis="YAxis")
chart.AssociateParameterToAxis(Parameter=outputParam2, Axis="YRightAxis")

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
196 of ANSYS, Inc. and its subsidiaries and affiliates.
Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

DX GDO Design of Experiment

This container holds Design of Experiment data for a Goal Driven Optimization.

Methods
GetModel
Get the DataReference of the Model. An exception is thrown if the entity is not found.

Return The DataReference of the Model.

Type DataReference

Example
The following example shows how the user can get a Model to change one of its properties.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
dOEModel1.DOEType = "eDOETYPE_OSFD"

Data Entities
BBDMethod
Entity which performs and manages the DesignXplorer Sampling Method Component

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 197
Design Exploration

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

CCDMethod
Entity which performs and manages the DesignXplorer Sampling Method Component

Properties
CCDTemplateType

Template Type for CCD algorithm.

Type CCDTemplateType

Read Only No

CCDType

Design Type for CCD algorithm.

Type CentralCompositeDesignType

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

CustomDOEMethod
Entity which performs and manages the DesignXplorer Sampling Method Component

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
198 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

CustomDOEPlusSampling
Entity which performs and manages the DesignXplorer Sampling Method Component

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

DiscreteLevel
The data entity which describes a Discrete Level of an Input Parameter.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Index

Zero-based Index of the discrete level in the list of levels of the owning parameter.

Type int

Read Only No

Value

Value of the DiscreteLevel.

Type Object

Read Only No

Methods
SetValue

Sets the value of a discrete level entity. A discrete level can have an integer value (e.g. a number if
holes, a number of turns, etc) or a string value (e.g. a material name or a geometry file name).

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 199
Design Exploration

Required Arguments

Value Value set to the discrete level entity.

Type Object

Example
The following example shows how to retrieve a discrete level from an input parameter and then change
its value.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DiscreteInputParameter = model.GetParameter(Name="P2")
level1 = DiscreteInputParameter.GetDiscreteLevel(Name="Level 1")
level1.SetValue( Value="2500" )

DistributionChart
The entity which describes a parameter's Distribution chart. This chart is always associated with an un-
certainty parameter and allows you to visualize the statistical distribution defined or calculated for this
parameter.

Properties
DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short
name such as "P1".

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Parameter

The parameter entity associated with the chart.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
200 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

Methods
ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date,
nothing is done by default.

Example
The following example shows how to update a Tradeoff chart. The same code applies to all other types of
charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart = model.GetChart(Name="TradeoffChart 1")
chart.Update()

DOEModel
Entity which performs and manages the DesignXplorer Design Of Experiments Component

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 201
Design Exploration

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ExportDesignPoints

If True and PreserveDesignPoints is True as well, export project for each preserved Design Point.

Type bool

Read Only No

Method

Optimization Method

Type DataReference

Read Only No

NumberOfRetries

Indicates the number of times DX will try to update the failed design points.

Type int

Read Only No

PreserveDesignPoints

If True, preserve the Design Points at the project level after the component Update.

Type bool

Read Only No

RetainDesignPoints

If True and PreserveDesignPoints is True as well, retain data for each preserved Design Point.

Type bool

Read Only No

RetryDelay

Indicates how much time will elapse between tries. This option is only applicable when NumberOfRetries
is greater than 0, otherwise it has no effect.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
202 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Quantity

Read Only No

Methods
CreateChart

Creates a Chart entity. The chart must be updated once after its creation by invoking its Update method.
Then changes to its properties will update the chart automatically.

Return The DataReference of the Chart.

Type DataReference

Required Arguments

ChartType Type of chart to be created. The possible values depend on the type of Model. For instance, a
ResponseSurface model accepts Spider, LocalSensitivity and Response chart while a Correla-
tionModel accepts CorrelationMatrix, DeterminationMatrix and CorrelationScatter charts.

Type ChartType

Optional Arguments

DisplayText Displayed name of the chart. If not specified, a default name is applied, depending on the
value of ChartType.

Type string

Example
The following example shows how to create a chart.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
TradeoffChart = model.CreateChart(ChartType="eChartTradeoff")
TradeoffChart.Update()

DeleteCharts

Deletes a list of Chart entities.

Required Arguments

Charts List of Chart entities to delete.

Type List<DataReference>

Example
The following example shows how to delete existing charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart1 = model.GetChart(Name="TradeoffChart 1")
chart2 = model.GetChart(Name="SamplesChart 1")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 203
Design Exploration

model.DeleteCharts(Charts=[chart1, chart2])

DuplicateChart

Duplicates a Chart entity. The chart must be updated once after its creation by invoking its Update
method. Then changes to its properties will update the chart automatically.

Return The DataReference of the Chart.

Type DataReference

Required Arguments

Chart The source chart to duplicate.

Type DataReference

Optional Arguments

DisplayText Displayed name of the chart. If not specified, a default name is applied, depending
on the value of ChartType.

Type string

TargetModel The model on which the duplicated chart is created. If this parameter is not set,
the model of the source chart is used.

Type DataReference

TargetResponsePoint Parent TargetResponsePoint of the chart. If this parameter is not set, the response
point of the source chart is used if applicable.

Type DataReference

Example
The following example shows how to duplicate a chart.

designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")

dOEModel1 = designofExperiment1.GetModel()
designPointsCurvesChart1 = dOEModel1.GetChart(Name="DesignPointsCurves")
chart1 = dOEModel1.DuplicateChart(Chart=designPointsCurvesChart1)
chart1.Update()

GetChart

Query to return the chart reference for a given model and chart name.

Return The DataReference of the chart.

Type DataReference

Required Arguments

Name Name of the chart.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
204 of ANSYS, Inc. and its subsidiaries and affiliates.
GetParameter

Get the DataReference of a Parameter. An exception is thrown if the entity is not found.

Return The DataReference of the Parameter.

Type DataReference

Required Arguments

Name Name of the Parameter.

Type string

Example
The following example shows how the user can get a parameter of a model to change one of its properties.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
inputParameter1 = dOEModel1.GetParameter(Name="P1")
inputParameter1.LowerBound = 1

GetParameters

Get the DataReferences of the InputParameter and OutputParameter of the model. If the optional argu-
ment InputParameters is not specified, the query returns all parameters. If it is specified and True, the
query returns only input parameters. If it is False, the query returns only output parameters.

Return The DataReferences of the Parameters

Type DataReferenceSet

Optional Arguments

InputParameters If True, the query returns only input parameters. If False, the query returns only output
parameters. If the argument is ommitted, the query returns all parameters.

Type bool

Example
The following example shows how the user can get the parameters of a model.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parameters = dOEModel1.GetParameters()

GetParametricTable

Get the DataReference of ParametricTable. An exception is thrown if the entity is not found. Names of
the tables generated internally are: "DesignPoints", "CorrelationMatrix", "CorrelationScatter", "MinDesign-
Points", "MaxDesignPoints", "ResponsePoints", "DeterminationMatrix".

Return The DataReference of the ParametricTable

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 205
Design Exploration

Type DataReference

Required Arguments

Name Name of the ParametricTable

Type string

Example
The following example shows how the user can get a ParametricTable to add a new row and set values.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
parametricTable.AddRow()
parametricTable.SetCellValue(RowIndex=9,ColumnIndex=0,Value="2.1")

ImportDesignPoints

Import existing Design Point entities in a custom Design of Experiments model. If a Design Point is
solved, the output parameter values are also imported.

Optional Arguments

DesignPoints List of the existing Design Point entities to import. If not specified, all the Design Point
entities found in the Parametric container are imported.

Type List<DataReference>

ExpandRanges If true, the command expands the range of variation of the input parameters based on the
imported design points. This is done by modifying automatically the upper and lower
bounds of the input parameters. If false, the design points which are not contained in the
actual variation ranges are not imported.

Type bool

Default Value False

Example
The following example shows how the user can import all design points or a list of design points into a
Design of Experiments model.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
model.ImportDesignPoints()
designPoint0 = Parameters.GetDesignPoint(Name="0")
designPoint1 = Parameters.GetDesignPoint(Name="1")
designPoint2 = Parameters.GetDesignPoint(Name="2")
model.ImportDesignPoints(DesignPoints=[designPoint0, designPoint1, designPoint2])
model.ImportDesignPoints(DesignPoints=[designPoint1])

ImportDesignPointsFromFile

Import Design Point values in a custom Design of Experiments model from a csv file.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
206 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

FileName The imported file name.

Type string

Optional Arguments

ExpandRanges If true, the command expands the range of variation of the input parameters based on the
imported design points. This is done by modifying automatically the upper and lower
bounds of the input parameters. If false, the design points which are not contained in the
actual variation ranges are not imported. This option is not supported in the context of a
DOE for a Six Sigma Analysis.

Type bool

Default Value False

Example
The following example shows how the user can import design points from a valid csv file.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
model.ImportDesignPointsFromFile(FilePath="designs.csv", ExpandRanges=True)

PreviewDesignPoints

Previews the Design Points of a model, without actually updating them, so that the user can adjust
settings before launching a long update operation. This command applies to a Design of Experiments
model, or the Refinement Points of a Kriging Response Surface, or a Parameters Correlation model. The
command returns the table of the generated points.

Return The DataReference of the ParametricTable containing the generated data.

Type DataReference

Example
The following example shows how to preview a DOE model.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DOEMatrix = model.PreviewDesignPoints()

InputParameter
The data entity which describes an Input Parameter in DesignXplorer.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 207
Design Exploration

Properties
Attribute1

First editable attribute of the distribution for an uncertainty parameter. The nature of the attribute de-
pends on the distribution type. For instance, the first attribute of a Normal distribution is the Mean
value.

Type double

Read Only No

Attribute2

Second editable attribute of the distribution for an uncertainty parameter. The nature of the attribute
depends on the distribution type. For instance, the second attribute of a Normal distribution is the
Standard Deviation value. Some distribution type do not have a second attribute.

Type double

Read Only No

ConstantValue

Constant value of the Parameter when it is disabled.

Type Object

Read Only No

CustomDefinitionList

Custom Definition List

Type List<DataReference>

Read Only No

DiscreteLevels

List of the discrete levels.

Type List<DataReference>

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
208 of ANSYS, Inc. and its subsidiaries and affiliates.
DistributionLowerBound

Distribution lower bound of the variation range for an uncertainty Parameter.

Type double

Read Only No

DistributionType

Distribution type for an uncertainty parameter.

Type DistributionType

Read Only No

DistributionUpperBound

Distribution upper bound of the variation range for an uncertainty Parameter.

Type double

Read Only No

Enabled

True if the Parameter is enabled for the current study.

Type bool

Read Only No

Kurtosis

Kurtosis value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

LowerBound

Lower bound of the variation range for a Continuous Parameter.

Type double

Read Only No

Mean

Mean value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 209
Design Exploration

Nature

Nature of the Parameter.

Type ParameterNature

Read Only No

NumberOfLevels

Number of levels if the parameter nature is Discrete, or the parameter nature is Continuous and the
UseManufacturableValues property is set to True.

Type int

Read Only Yes

Skewness

Skewness value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

StandardDeviation

Standard deviation value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

Type

Type of the Parameter, either a DesignVariable in a GDO context, or an UncertaintyVariable in a SixSigma

Analysis context.

Type SimulationType

Read Only Yes

Units

Units

Type string

Read Only Yes

UpperBound

Upper bound of the variation range for a Continuous Parameter.

Type double

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
210 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

UseManufacturableValues

True to restrict the variation of the parameter to defined Manufacturable Values.

Type bool

Read Only No

Methods
AddDiscreteLevel

Adds a Discrete Level entity on a discrete input parameter. A discrete level can have an integer value
(e.g. a number of holes, a number of turns, etc) or a string value (e.g. a material name or a geometry
file name). The command has optional arguments to specify the Name of the level and its Index in the
list of levels of the parameter. By default, the new level is added to the end of the list. The various discrete
levels of an input parameter represent independent configurations of the project, processed in the order
of their creation.

Return The created entity.

Type DataReference

Required Arguments

Value The value of the discrete level. Value can be an integer or a string.

Type Object

Optional Arguments

DisplayText DisplayText of the created entity. If not specified, a default name of the form "Level [#]" is
used.

Type string

Index The position of the new level in the list of discrete levels of the parameter. Index is zero-
based. If it is not specified, the new level is appended to the list.

Type int

Default Value -1

Example
The following example shows how to add new discrete levels on a discrete input parameter. The third
level is inserted between the two others.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DiscreteInputParameter = model.GetParameter(Name="P2")
DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 211
Design Exploration

AddLevels

Adds a list of levels to a continuous input parameter. Each level is a quantity or a real number corres-
ponding to a manufacturable value. The list of levels forms a restriction filter used when post-processing
the input parameter. If levels are added outside of the variation range, the lower and upper bounds
are adjusted accordingly.

Required Arguments

Levels List of added levels.

Type List<string>

Optional Arguments

Overwrite True in order to overwrite the existing levels, False by default.

Type bool

Example
The following example shows how to overwrite the manufacturable values of an input parameter and how
to define an additional value later.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
InputParameter = model.GetParameter(Name="P1")
InputParameter.UseManufacturableValues = True
InputParameter.AddLevels(Levels=["0.3 [mm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
InputParameter.AddLevels(Levels="7 [mm]")

CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter The parameter on which the criterion is created.

Type DataReference

Example
The following example shows how to create an OptimizationCriterion entity.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameter1 = model.GetParameter(Name="P1")
optimizationCriterion = parameter1.CreateOptimizationCriterion()

DeleteDiscreteLevels

Deletes a list of levels from a discrete input parameter.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
212 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

DiscreteLevels List of the DiscreteLevel entities to delete.

Type List<DataReference>

Example
The following example shows how to add and then delete one or more levels from a discrete input para-
meter.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DiscreteInputParameter = model.GetParameter(Name="P1")
level1 = DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
level2 = DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
level3 = DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")
DiscreteInputParameter.DeleteDiscreteLevels(DiscreteLevels=[level1, level2])

DeleteLevels

Deletes a list of levels from a continuous input parameter.

Required Arguments

Indices Indices of the items to remove from the levels list

Type List<int>

Example
The following example shows how to add and then delete one or more levels from a continuous input
parameter for which the UseManufacturableValues property is set to True.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
InputParameter = model.GetParameter(Name="P1")
InputParameter.UseManufacturableValues = True
InputParameter.AddLevels(Levels=["0.3 [mmm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
InputParameter.DeleteLevels( Indices=[0, 1] )

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 213
Design Exploration

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

GetCustomParameterDefinition

Get the DataReference of a CustomParameterProperties entity associated with an Input Parameter. An

exception is thrown if the entity is not found.

Return The DataReference of the CustomParameterProperties.

Type DataReference

Required Arguments

ExtensionName Extension's Name.

Type string

Example
The following example shows how the user can get a CustomParameterProperties.

system1 = GetSystem(Name="DOP")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
inputParameter1 = optimizationModel1.GetParameter(Name="P1")
customParameterDefinition1 = inputParameter1.GetCustomParameterDefinition(ExtensionName="UncertaintyParamet
customParameterDefinition1.Distribution = "Triangular"

GetDiscreteLevel

Get a discrete level by name from an input parameter. The parameter's full and ordered list of discrete
levels is available as its "DiscreteLevels" property.

Return The DataReference of the discrete level entity.

Type DataReference

Required Arguments

Name The name of the discrete level.

Type string

Example
The following example shows how the user can retrieve a discrete level of a discrete input parameter by
its name.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
214 of ANSYS, Inc. and its subsidiaries and affiliates.
 system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
DiscreteInputParameter1 = dOEModel1.GetParameter(Name="P1")
level = DiscreteInputParameter1.GetDiscreteLevel(Name="Level 1")

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown
if the entity is not found.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter Parent Parameter.

Type DataReference

Example
The following example shows how the user can get a OptimizationCriterion to change one of its properties.

system1 = GetSystem(Name="RSO")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
parameter3 = optimizationModel1.GetParameter(Name="P3")
optimizationCriterion = parameter3.GetOptimizationCriterion()
optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return The DataReference of the ParameterStatistics entity.

Type DataReference

Example
The following example shows how the user can get a ParameterStatistics entity and examine its Mean
property.

system1 = GetSystem(Name="SSA")
sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
parameter4 = sixSigmaModel1.GetParameter(Name="P4")
parameterStatistics1 = parameter4.GetParameterStatistics()
mean = parameterStatistics1.Mean

LHSDMethod
Entity which performs and manages the DesignXplorer Sampling Method Component

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 215
Design Exploration

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

NumSamp

Number of Samples for User-Defined LHSD algorithm.

Type int

Read Only No

RandomGeneratorSeed

Seed value for LHS and LHSD algorithm.

Type int

Read Only No

SampType

Samples Type for LHS and LHSD algorithm.

Type NumSampType

Read Only No

OSFDMethod
Entity which performs and manages the DesignXplorer Optimization Method Component

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

MaxNumCycles

Maximum Number Of Cycles for OSFD algorithm.

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
216 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

NumSamp

Number of Samples for User-Defined OSFD algorithm.

Type int

Read Only No

OSFDType

Design Type for OSFD algorithm.

Type OptimalSpaceFillingType

Read Only No

RandomGeneratorSeed

Seed value for LHS and OSFD algorithm.

Type int

Read Only No

SampType

Samples Type for LHS and OSFD algorithm.

Type NumSampType

Read Only No

OutputParameter
Output parameter entity for DesignXplorer.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IgnoreForFiltering

Determines whether the parameter filtering is not applicable to the output parameter in the correlation
context.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 217
Design Exploration

Read Only No

InheritFromModelSettings

Determines whether the Maximum Predicted Relative Error defined at the Model level is applicable to
the output parameter.

Type bool

Read Only No

LowerBound

Minimum value extracted from existing design points and/or sample sets.

Type double

Read Only Yes

MaxPredictedRelativeError

Maximum Relative Error targeted for an output parameter when refining with the Kriging algorithm.
This is the maximum predicted relative error that is acceptable for the selected output parameter.

Type double

Read Only No

PredictedRelativeError

Current value of the Predicted Relative Error when refining with the Kriging algorithm

Type double

Read Only Yes

TransformationType

Transformation Type

Type TransformationType

Read Only No

Units

Units

Type string

Read Only Yes

UpperBound

Maximum value extracted from existing design points and/or sample sets.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
218 of ANSYS, Inc. and its subsidiaries and affiliates.
Type double

Read Only Yes

Methods
CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter The parameter on which the criterion is created.

Type DataReference

Example
The following example shows how to create an OptimizationCriterion entity.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameter1 = model.GetParameter(Name="P1")
optimizationCriterion = parameter1.CreateOptimizationCriterion()

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown
if the entity is not found.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter Parent Parameter.

Type DataReference

Example
The following example shows how the user can get a OptimizationCriterion to change one of its properties.

system1 = GetSystem(Name="RSO")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
parameter3 = optimizationModel1.GetParameter(Name="P3")
optimizationCriterion = parameter3.GetOptimizationCriterion()
optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 219
Design Exploration

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return The DataReference of the ParameterStatistics entity.

Type DataReference

Example
The following example shows how the user can get a ParameterStatistics entity and examine its Mean
property.

system1 = GetSystem(Name="SSA")
sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
parameter4 = sixSigmaModel1.GetParameter(Name="P4")
parameterStatistics1 = parameter4.GetParameterStatistics()
mean = parameterStatistics1.Mean

SamplingMethod
Entity which wraps and manages the external Sampling Method for the Design of Experiments component

Properties
No Properties.

SPGDMethod
Entity which performs and manages the DesignXplorer Sampling Method Component

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

DX GDO Response Surface

This container holds Response Surface data for a Goal Driven Optimization.

Methods
GetModel
Get the DataReference of the Model. An exception is thrown if the entity is not found.

Return The DataReference of the Model.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
220 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataReference

Example
The following example shows how the user can get a Model to change one of its properties.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
dOEModel1.DOEType = "eDOETYPE_OSFD"

Data Entities
GoodnessOfFit
Entity which manages the Goodness Of Fit Information of a Response Surface for an Output Parameter

Properties
DiscreteExpressions

A Dictionary holding the values of all discrete input. Note: Discrete parameter values are level values,
not indices.

Type Dictionary<DataReference, Object>

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

Methods
CreateAdvancedReport

For the standard response surface only (Full second order Polynomials), creates an Advanced Goodness
of Fit report for any direct output parameter.

Return A string which contains the generated Advanced Goodness of Fit report.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 221
Design Exploration

Required Arguments

Parameter Parent Parameter of the report.

Type DataReference

Optional Arguments

PlainTextFormat Plain text formatting instead of HTML (default).

Type bool

Default Value False

Example
The following example shows how to create an Advanced Goodness of Fit report.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
gof1 = model.GetGoodnessOfFit(Name="GoodnessOfFit")
outputParameter1 = model.GetParameter(Name="P4")
report1 = gof1.CreateAdvancedReport(Parameter=outputParameter1)

SetDiscreteParameter

Sets the Expression of a discrete input parameter in a GoodnessOfFit and updates the associated output
parameter values. The chart entities depending on the GoodnessOfFit are updated as well.

Required Arguments

DiscreteParameter DataReference of the Discrete Input parameter.

Type DataReference

Expression Assigned Expression (discrete value).

Type string

Example
The following example shows how to set the expression for one discrete parameter in an existing Good-
nessOfFit.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
gof = model.GetGoodnessOfFit(Name="Goodness Of Fit")
inputParameter1 = model.GetParameter(Name="P1")
gof.SetDiscreteParameter(DiscreteParameter=inputParameter1, Expression="15")

Update

Updates the goodness of fit and the results which depend on it. If the goodness of fit is already uptodate,
nothing is done unless the Force flag is set to True.

Optional Arguments

Force Set to true if the update operation of the goodness of fit point is required even if it's already uptodate.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
222 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type bool

Default Value False

Example
The following example shows how to update an existing GoodnessOfFit.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
gof1 = model.GetGoodnessOfFit(Name="GOF 1")
gof1.Update()

InputParameter
The data entity which describes an Input Parameter in DesignXplorer.

Properties
Attribute1

First editable attribute of the distribution for an uncertainty parameter. The nature of the attribute de-
pends on the distribution type. For instance, the first attribute of a Normal distribution is the Mean
value.

Type double

Read Only No

Attribute2

Second editable attribute of the distribution for an uncertainty parameter. The nature of the attribute
depends on the distribution type. For instance, the second attribute of a Normal distribution is the
Standard Deviation value. Some distribution type do not have a second attribute.

Type double

Read Only No

ConstantValue

Constant value of the Parameter when it is disabled.

Type Object

Read Only No

CustomDefinitionList

Custom Definition List

Type List<DataReference>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 223
Design Exploration

DiscreteLevels

List of the discrete levels.

Type List<DataReference>

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

DistributionLowerBound

Distribution lower bound of the variation range for an uncertainty Parameter.

Type double

Read Only No

DistributionType

Distribution type for an uncertainty parameter.

Type DistributionType

Read Only No

DistributionUpperBound

Distribution upper bound of the variation range for an uncertainty Parameter.

Type double

Read Only No

Enabled

True if the Parameter is enabled for the current study.

Type bool

Read Only No

Kurtosis

Kurtosis value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
224 of ANSYS, Inc. and its subsidiaries and affiliates.
LowerBound

Lower bound of the variation range for a Continuous Parameter.

Type double

Read Only No

Mean

Mean value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

Nature

Nature of the Parameter.

Type ParameterNature

Read Only No

NumberOfLevels

Number of levels if the parameter nature is Discrete, or the parameter nature is Continuous and the
UseManufacturableValues property is set to True.

Type int

Read Only Yes

Skewness

Skewness value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

StandardDeviation

Standard deviation value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

Type

Type of the Parameter, either a DesignVariable in a GDO context, or an UncertaintyVariable in a SixSigma

Analysis context.

Type SimulationType

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 225
Design Exploration

Read Only Yes

Units

Units

Type string

Read Only Yes

UpperBound

Upper bound of the variation range for a Continuous Parameter.

Type double

Read Only No

UseManufacturableValues

True to restrict the variation of the parameter to defined Manufacturable Values.

Type bool

Read Only No

Methods
AddDiscreteLevel

Adds a Discrete Level entity on a discrete input parameter. A discrete level can have an integer value
(e.g. a number of holes, a number of turns, etc) or a string value (e.g. a material name or a geometry
file name). The command has optional arguments to specify the Name of the level and its Index in the
list of levels of the parameter. By default, the new level is added to the end of the list. The various discrete
levels of an input parameter represent independent configurations of the project, processed in the order
of their creation.

Return The created entity.

Type DataReference

Required Arguments

Value The value of the discrete level. Value can be an integer or a string.

Type Object

Optional Arguments

DisplayText DisplayText of the created entity. If not specified, a default name of the form "Level [#]" is
used.

Type string

Index The position of the new level in the list of discrete levels of the parameter. Index is zero-
based. If it is not specified, the new level is appended to the list.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
226 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type int

Default Value -1

Example
The following example shows how to add new discrete levels on a discrete input parameter. The third
level is inserted between the two others.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DiscreteInputParameter = model.GetParameter(Name="P2")
DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")

AddLevels

Adds a list of levels to a continuous input parameter. Each level is a quantity or a real number corres-
ponding to a manufacturable value. The list of levels forms a restriction filter used when post-processing
the input parameter. If levels are added outside of the variation range, the lower and upper bounds
are adjusted accordingly.

Required Arguments

Levels List of added levels.

Type List<string>

Optional Arguments

Overwrite True in order to overwrite the existing levels, False by default.

Type bool

Example
The following example shows how to overwrite the manufacturable values of an input parameter and how
to define an additional value later.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
InputParameter = model.GetParameter(Name="P1")
InputParameter.UseManufacturableValues = True
InputParameter.AddLevels(Levels=["0.3 [mm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
InputParameter.AddLevels(Levels="7 [mm]")

CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter The parameter on which the criterion is created.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 227
Design Exploration

Type DataReference

Example
The following example shows how to create an OptimizationCriterion entity.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameter1 = model.GetParameter(Name="P1")
optimizationCriterion = parameter1.CreateOptimizationCriterion()

DeleteDiscreteLevels

Deletes a list of levels from a discrete input parameter.

Required Arguments

DiscreteLevels List of the DiscreteLevel entities to delete.

Type List<DataReference>

Example
The following example shows how to add and then delete one or more levels from a discrete input para-
meter.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DiscreteInputParameter = model.GetParameter(Name="P1")
level1 = DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
level2 = DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
level3 = DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")
DiscreteInputParameter.DeleteDiscreteLevels(DiscreteLevels=[level1, level2])

DeleteLevels

Deletes a list of levels from a continuous input parameter.

Required Arguments

Indices Indices of the items to remove from the levels list

Type List<int>

Example
The following example shows how to add and then delete one or more levels from a continuous input
parameter for which the UseManufacturableValues property is set to True.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
InputParameter = model.GetParameter(Name="P1")
InputParameter.UseManufacturableValues = True
InputParameter.AddLevels(Levels=["0.3 [mmm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
InputParameter.DeleteLevels( Indices=[0, 1] )

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
228 of ANSYS, Inc. and its subsidiaries and affiliates.
ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

GetCustomParameterDefinition

Get the DataReference of a CustomParameterProperties entity associated with an Input Parameter. An

exception is thrown if the entity is not found.

Return The DataReference of the CustomParameterProperties.

Type DataReference

Required Arguments

ExtensionName Extension's Name.

Type string

Example
The following example shows how the user can get a CustomParameterProperties.

system1 = GetSystem(Name="DOP")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
inputParameter1 = optimizationModel1.GetParameter(Name="P1")
customParameterDefinition1 = inputParameter1.GetCustomParameterDefinition(ExtensionName="UncertaintyParamet
customParameterDefinition1.Distribution = "Triangular"

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 229
Design Exploration

GetDiscreteLevel

Get a discrete level by name from an input parameter. The parameter's full and ordered list of discrete
levels is available as its "DiscreteLevels" property.

Return The DataReference of the discrete level entity.

Type DataReference

Required Arguments

Name The name of the discrete level.

Type string

Example
The following example shows how the user can retrieve a discrete level of a discrete input parameter by
its name.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
DiscreteInputParameter1 = dOEModel1.GetParameter(Name="P1")
level = DiscreteInputParameter1.GetDiscreteLevel(Name="Level 1")

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown
if the entity is not found.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter Parent Parameter.

Type DataReference

Example
The following example shows how the user can get a OptimizationCriterion to change one of its properties.

system1 = GetSystem(Name="RSO")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
parameter3 = optimizationModel1.GetParameter(Name="P3")
optimizationCriterion = parameter3.GetOptimizationCriterion()
optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return The DataReference of the ParameterStatistics entity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
230 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataReference

Example
The following example shows how the user can get a ParameterStatistics entity and examine its Mean
property.

system1 = GetSystem(Name="SSA")
sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
parameter4 = sixSigmaModel1.GetParameter(Name="P4")
parameterStatistics1 = parameter4.GetParameterStatistics()
mean = parameterStatistics1.Mean

MinMaxSearch
The data entity which described the MinMax Search option of a Response Surface Component.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Enabled

If True, performs a min-max search performed when the response surface is built.

Type bool

Read Only No

IsUpToDate

True if the entity is up-to-date.

Type bool

Read Only No

NumberInitialPoints

Number of initial samples for the min-max search algorithm.

Type int

Read Only No

NumberStartPoints

Number of start points for the min-max search algorithm.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 231
Design Exploration

Type int

Read Only No

OutputParameter
Output parameter entity for DesignXplorer.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IgnoreForFiltering

Determines whether the parameter filtering is not applicable to the output parameter in the correlation
context.

Type bool

Read Only No

InheritFromModelSettings

Determines whether the Maximum Predicted Relative Error defined at the Model level is applicable to
the output parameter.

Type bool

Read Only No

LowerBound

Minimum value extracted from existing design points and/or sample sets.

Type double

Read Only Yes

MaxPredictedRelativeError

Maximum Relative Error targeted for an output parameter when refining with the Kriging algorithm.
This is the maximum predicted relative error that is acceptable for the selected output parameter.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
232 of ANSYS, Inc. and its subsidiaries and affiliates.
PredictedRelativeError

Current value of the Predicted Relative Error when refining with the Kriging algorithm

Type double

Read Only Yes

TransformationType

Transformation Type

Type TransformationType

Read Only No

Units

Units

Type string

Read Only Yes

UpperBound

Maximum value extracted from existing design points and/or sample sets.

Type double

Read Only Yes

Methods
CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter The parameter on which the criterion is created.

Type DataReference

Example
The following example shows how to create an OptimizationCriterion entity.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameter1 = model.GetParameter(Name="P1")
optimizationCriterion = parameter1.CreateOptimizationCriterion()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 233
Design Exploration

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown
if the entity is not found.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter Parent Parameter.

Type DataReference

Example
The following example shows how the user can get a OptimizationCriterion to change one of its properties.

system1 = GetSystem(Name="RSO")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
parameter3 = optimizationModel1.GetParameter(Name="P3")
optimizationCriterion = parameter3.GetOptimizationCriterion()
optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return The DataReference of the ParameterStatistics entity.

Type DataReference

Example
The following example shows how the user can get a ParameterStatistics entity and examine its Mean
property.

system1 = GetSystem(Name="SSA")
sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
parameter4 = sixSigmaModel1.GetParameter(Name="P4")
parameterStatistics1 = parameter4.GetParameterStatistics()
mean = parameterStatistics1.Mean

ParametricTable
ParametricTable entity used to encapsulate most of the evaluation results in a convenient 2D matrix
format.

Properties
DimCol

Number of columns.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
234 of ANSYS, Inc. and its subsidiaries and affiliates.
Type int

Read Only Yes

DimRow

Number of rows.

Type int

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Methods
AddRow

Adds a row to the bottom of a ParametricTable entity.

Optional Arguments

RowValues New values for the row.

Type List<string>

Example
The following example shows how to make a DOE editable, to retrieve the table of design points and add
a new row to it.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.AddRow()

DeleteRows

Delete rows from a ParametricTable entity.

Required Arguments

Indices Indices of the rows to delete.

Type List<int>

Example
The following example shows how to delete rows from the DOEmatrix in a custom DOE context.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 235
Design Exploration

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.DeleteRows(Indices=[0,7,8,9])

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

GetCellValue

Get the Value of a ParametricTable's cell. An exception is thrown if the entity is not found.

Return The value of the cell.

Type string

Required Arguments

ColumnIndex ColumnIndex (zero-based) of the cell.

Type int

RowIndex RowIndex (zero-based) of the cell.

Type int

Example
The following example shows how the user can get the value of the ParametricTable's cell [0,3].

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
236 of ANSYS, Inc. and its subsidiaries and affiliates.
 system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
cellValue = parametricTable.GetCellValue(RowIndex=0,ColumnIndex=3)

GetRowUpdateOrder

Get the Update Order value of a row in a ParametricTable. An exception is thrown if the entity is not
found.

Return The value of the update order.

Type double

Required Arguments

RowIndex RowIndex (zero-based) of the cell.

Type int

Example
The following example shows how to get the Update Order value of row [3] in the ParametricTable.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
updateOrderValue = parametricTable.GetRowUpdateOrder(RowIndex=3)

GetRowValues

Get the Values of a ParametricTable's row. An exception is thrown if the entity is not found.

Return List of the values of the specified row.

Type List<string>

Required Arguments

RowIndex RowIndex (zero-based) of the row to retrieve.

Type int

Example
The following example shows how the user can get the values of the 4th ParametricTable's row.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
rowValues = parametricTable.GetRowValues(RowIndex=3)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 237
Design Exploration

OptimizeUpdateOrder

Optimizes the Update Order of Design Points to minimize the number of modifications between two
consecutive Design Points. This command applies to the "DesignPoints" ParametricTable of a Design
of Experiments model or of a Response Surface in a manual refinement context. It also applies to the
"VerificationPoints" ParametricTable of a Response Surface model.

Example
The following example shows how to optimize the update order of the DesignPoints table in a Design of
Experiments model.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.OptimizeUpdateOrder()

SetCellValue

Sets the value of a ParametricTable cell. If the table is read-only, the command has no effect.

Required Arguments

ColumnIndex Zero-based column index of the cell.

Type int

RowIndex Zero-based row index of the cell.

Type int

Value New value of the cell.

Type string

Example
The following example shows how to set the value of the DesignPoints table in a custom DOE context.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.AddRow()
DOEMatrix.SetCellValue(RowIndex=0, ColumnIndex=0, Value="12.5 [mm]")

SetOutputValuesEditable

Sets the values of the output parameters as Editable (Editable=True) or Calculated (Editable=False) for
the complete table, or a set of rows specified by the RowIndices argument. This command is applicable
to the "DesignPoints" ParametricTable of a Design of Experiments model in a custom context (DOEType
is "eDOETYPE_USER" or "eDOETYPE_CUSTOM_OSFD") or of a Response Surface model in a manual re-
finement context. It also applies to the "VerificationPoints" ParametricTable of a Response Surface
model.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
238 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Editable True to define output values as Editable, or False to mark output values as calculated.

Type bool

Optional Arguments

RowIndices Optional list of row zero-based indices. If this argument is not specified, the command applies
to the complete ParametricTable.

Type List<int>

Example
The following example shows how to switch a DOE model to the custom mode and then set the output
values as editable for the first three design points of the DOE matrix.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.SetOutputValuesEditable(Editable=True, RowIndices=[0,1,2])

SetRowUpdateOrder

Sets the Update Order value for a row in a ParametricTable. If the table doesn't support Update Order
functionality, the command has no effect.

Required Arguments

RowIndex Zero-based row index of the cell.

Type int

UpdateOrder New value of the update order.

Type double

Example
The following example shows how to set the Update Order value of the DesignPoints table in a Design of
Experiments model.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.SetRowUpdateOrder(RowIndex=0, Value="2.0")

SetRowValues

Sets the values of a ParametricTable's row. If the table is read-only, the command has no effect.

Required Arguments

RowIndex Zero-based row index of the cell.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 239
Design Exploration

Type int

RowValues New values for the row.

Type List<string>

Example
The following example shows how to set the values of the DesignPoints table in a custom DOE context.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.AddRow()
DOEMatrix.SetRowValues(RowIndex=0, RowValues=[ "12.5 [mm]", "1" ] )

SetUpdateOrderByRow

Sets a value for the UpdateOrder property of all Design Points using sorting settings. This command
applies to the "DesignPoints" ParametricTable of a Design of Experiments model or of a Response Surface
in a manual refinement context. It also applies to the "VerificationPoints" ParametricTable of a Response
Surface model.

Optional Arguments

SortBy Definition of the sort.

Type List<string>

Example
The following example shows how to set the update order of the DesignPoints table in a Design of Exper-
iments model. The Design Points are sorted first by their values for the parameter P3 (in ascending order),
and then by their values for the parameter P1 (in descending order).

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.SetUpdateOrderByRow(SortBy=["P3:+", "P1:-"])

UpdateRows

Updates the design points held in rows from a ParametricTable entity and the results which depend
on it.

Required Arguments

Indices Indices of the rows to update.

Type List<int>

Example
The following example shows how to update the design points from the VerificationPoints Table.

responseSurface1 = system1.GetContainer(ComponentName="Response Surface")

responseSurfaceModel1 = responseSurface1.GetModel()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
240 of ANSYS, Inc. and its subsidiaries and affiliates.
 parametricTable1 = responseSurfaceModel1.GetParametricTable(Name="VerificationPoints")
parametricTable1.UpdateRows(Indices=[0,1])

ResponseSurfaceModel
Entity which performs and manages the DesignXplorer Response Surface Component

Properties
Converged

Convergence state

Type bool

Read Only Yes

CrowdingDistSeparationPercentage

Crowding Distance Separation Percentage when refining with the Kriging algorithm

Type double

Read Only No

CurrentRelativeError

Current value of the Relative Error

Type double

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ExportDesignPoints

If True and PreserveDesignPoints is True as well, export project for each preserved Design Point.

Type bool

Read Only No

FittingType

Response Surface Type

Type FittingType

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 241
Design Exploration

Read Only No

GenerateVerificationPoints

If True, generate verification points.

Type bool

Read Only No

KernelVariationType

Kernel Variation Type for the Kriging algorithm

Type KernelVariationType

Read Only No

MaximumDepth

Maximum Depth limit when refining with the Sparse Grid response surface

Type int

Read Only No

MaximumRelativeErrorSparseGrid

Maximum Relative Error targeted when refining with the Sparse Grid response surface

Type double

Read Only No

MaxNumberRefinementPointsKriging

Maximum Number Of Refinement Points that can be generated for refinement with the Kriging algorithm.

Type int

Read Only No

MaxNumberRefinementPointsSparseGrid

Maximum Number Of Refinement Points that can be generated for refinement with the Sparse Grid
response surface

Type int

Read Only No

MaxPredictedRelativeError

Maximum Relative Error targeted for all input parameters when refining with the Kriging algorithm.
This is the maximum predicted relative error that is acceptable for all parameters.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
242 of ANSYS, Inc. and its subsidiaries and affiliates.
Type double

Read Only No

NumberOfCells

Number of Cells for the Neural Network algorithm

Type int

Read Only No

NumberOfRetries

Indicates the number of times DX will try to update the failed design points.

Type int

Read Only No

NumberRefinementPoints

Number Of existing Refinement Points

Type int

Read Only Yes

NumberVerificationPoints

Number of verification points to generate.

Type int

Read Only No

OutputVarCombinations

Output Variable Combinations when refining with the Kriging algorithm. Controls how output variables
are considered in terms of Predicated Relative Error and determines the number of refinement points
generated per iteration.

Type AdaptKrigOutType

Read Only No

PredictedRelativeError

Current value of the Predicted Relative Error when refining with the Kriging algorithm

Type double

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 243
Design Exploration

PreserveDesignPoints

If True, preserve the Design Points at the project level after the component Update.

Type bool

Read Only No

RefinementType

Refinement Type

Type ResponseSurfaceRefinementType

Read Only No

RetainDesignPoints

If True and PreserveDesignPoints is True as well, retain data for each preserved Design Point.

Type bool

Read Only No

RetryDelay

Indicates how much time will elapse between tries. This option is only applicable when NumberOfRetries
is greater than 0, otherwise it has no effect.

Type Quantity

Read Only No

Methods
CreateChart

Creates a Chart entity. The chart must be updated once after its creation by invoking its Update method.
Then changes to its properties will update the chart automatically.

Return The DataReference of the Chart.

Type DataReference

Required Arguments

ChartType Type of chart to be created. The possible values depend on the type of Model. For instance, a
ResponseSurface model accepts Spider, LocalSensitivity and Response chart while a Correla-
tionModel accepts CorrelationMatrix, DeterminationMatrix and CorrelationScatter charts.

Type ChartType

Optional Arguments

DisplayText Displayed name of the chart. If not specified, a default name is applied, depending on the
value of ChartType.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
244 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Example
The following example shows how to create a chart.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
TradeoffChart = model.CreateChart(ChartType="eChartTradeoff")
TradeoffChart.Update()

CreateGoodnessOfFit

Creates a GoodnessOfFit. The ParameterValues dictionary can be used to specify a value for some or
all of the discrete input parameters.

Return The created entity.

Type DataReference

Optional Arguments

DisplayText DisplayText of the created entity. If not specified, a default name of the form "Goodness
Of Fit [#]" is used.

Type string

ParameterValues The values for each discrete input parameter. If not specified, each parameter is initial-
ized to the current level.

Type Dictionary<DataReference, string>

Example
The following example shows how to create a GoodnessOfFit from an existing ResponseSurface model.
The code retrieves the parameters P1 and P2 and then creates the response point by assigning a value to
each of these parameters.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
inputParameter1 = model.GetParameter(Name="P1")
inputParameter2 = model.GetParameter(Name="P2")
goodnessOfFit = model.CreateGoodnessOfFit( DisplayText="GOF1",
ParameterValues={inputParameter1: "2", inputParameter2: "15"})

CreateResponsePoint

Creates a ResponsePoint. The ParameterValues dictionary can be used to specify a value or a quantity
for some or all of the input parameters. The output parameter values cannot be specified. They are
evaluated automatically from the ResponseSurface model once it is updated. Several types of charts
can only be created as children of a ResponsePoint. These charts depend on the ResponsePoint and
use the same parameter values.

Return The created entity.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 245
Design Exploration

Optional Arguments

DisplayText DisplayText of the created entity. If not specified, a default name of the form "Response
Point [#]" is used.

Type string

ParameterValues The values for each input parameter. If not specified, each parameter is initialized to
the middle of its variation range.

Type IDictionary<DataReference, string>

Example
The following example shows how to create a ResponsePoint from an existing ResponseSurface model.
The code retrieves the parameters P1 and P2 and then creates the response point by assigning a value to
each of these parameters.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
inputParameter1 = model.GetParameter(Name="P1")
inputParameter2 = model.GetParameter(Name="P2")
responsePoint = model.CreateResponsePoint( DisplayText="Improved Design",
ParameterValues={inputParameter1: "2.01", inputParameter2: "15.5"})

DeleteCharts

Deletes a list of Chart entities.

Required Arguments

Charts List of Chart entities to delete.

Type List<DataReference>

Example
The following example shows how to delete existing charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart1 = model.GetChart(Name="TradeoffChart 1")
chart2 = model.GetChart(Name="SamplesChart 1")
model.DeleteCharts(Charts=[chart1, chart2])

DeleteGoodnessOfFit

Deletes a list of GoodnessOfFit entities and all the depending Chart entities.

Required Arguments

GoodnessOfFit DataReferences of the entities to delete

Type List<DataReference>

Example
The following example shows how to delete existing GoodnessOfFit.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
246 of ANSYS, Inc. and its subsidiaries and affiliates.
 container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
gof1 = model.GetGoodnessOfFit(Name="GOF 1")
gof5 = model.GetGoodnessOfFit(Name="GOF 5")
gof6 = model.GetGoodnessOfFit(Name="GOF 6")
model.DeleteGoodnessOfFit(GoodnessOfFit=[gof1, gof5, gof6])

DeleteResponsePoints

Deletes a list of ResponsePoint entities and all the depending Chart entities.

Required Arguments

ResponsePoints DataReferences of the entities to delete

Type List<DataReference>

Example
The following example shows how to delete existing ResponsePoints.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
rp1 = model.GetResponsePoint(Name="Response Point 1")
rp5 = model.GetResponsePoint(Name="Response Point 5")
rp6 = model.GetResponsePoint(Name="Response Point 6")
model.DeleteResponsePoints(ResponsePoints=[rp1, rp5, rp6])

DuplicateChart

Duplicates a Chart entity. The chart must be updated once after its creation by invoking its Update
method. Then changes to its properties will update the chart automatically.

Return The DataReference of the Chart.

Type DataReference

Required Arguments

Chart The source chart to duplicate.

Type DataReference

Optional Arguments

DisplayText Displayed name of the chart. If not specified, a default name is applied, depending
on the value of ChartType.

Type string

TargetModel The model on which the duplicated chart is created. If this parameter is not set,
the model of the source chart is used.

Type DataReference

TargetResponsePoint Parent TargetResponsePoint of the chart. If this parameter is not set, the response
point of the source chart is used if applicable.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 247
Design Exploration

Type DataReference

Example
The following example shows how to duplicate a chart.

designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")

dOEModel1 = designofExperiment1.GetModel()
designPointsCurvesChart1 = dOEModel1.GetChart(Name="DesignPointsCurves")
chart1 = dOEModel1.DuplicateChart(Chart=designPointsCurvesChart1)
chart1.Update()

DuplicateGoodnessOfFit

Duplicates a GoodnessOfFit.

Return The created entity.

Type DataReference

Required Arguments

GoodnessOfFit DataReference of the GoodnessOfFit.

Type DataReference

Optional Arguments

DisplayText DisplayText of the created entity. If not specified, a default name of the form "Goodness Of
Fit [#]" is used.

Type string

TargetModel The ResponseSurface model on which the goodness of fit is created. If this parameter is not
set, the model of the source goodness of fit is used.

Type DataReference

Example
The following example shows how to duplicate a GoodnessOfFit from an existing ResponseSurface model.
The code retrieves the parameters P1 and P2 and then creates the response point by assigning a value to
each of these parameters.

container = system1.GetContainer(ComponentName="Response Surface")

responseSurfaceModel1 = container.GetModel()
gof = responseSurfaceModel1.GetGoodnessOfFit(Name="GoodnessOfFit")
goodnessOfFit2 = model.DuplicateGoodnessOfFit(GoodnessOfFit=gof, DisplayText="GOF2")
goodnessOfFit2.Update()

DuplicateResponsePoint

Duplicates a ReponsePoint entity. The response point must be updated once after its creation by invoking
its Update method. Then changes to its properties will update the response point automatically.

Return The created entity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
248 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataReference

Required Arguments

ResponsePoint The source response point to duplicate.

Type DataReference

Optional Arguments

DisplayText DisplayText of the created entity. If not specified, a default name of the form "Response
Point [#]" is used.

Type string

DuplicateCharts True if the charts of the response point have to be duplicated.

Type bool

Default Value False

TargetModel The model on which the duplicated response point is created. If this parameter is not
set, the model of the source response point is used.

Type DataReference

Example
The following example shows how to duplicate a response point and all its charts.

responseSurface1 = system1.GetContainer(ComponentName="Response Surface")

responseSurfaceModel1 = responseSurface1.GetModel()
responsePoint1 = responseSurfaceModel1.GetResponsePoint(Name="ResponsePoint")
responsePoint2 = responseSurfaceModel1.DuplicateResponsePoint(ResponsePoint=responsePoint1,DuplicateCharts=
responsePoint2.Update()

GetChart

Query to return the chart reference for a given model and chart name.

Return The DataReference of the chart.

Type DataReference

Required Arguments

Name Name of the chart.

Type string

GetGoodnessOfFit

Get the DataReference of a GoodnessOfFit entity associated with a Model. An exception is thrown if
the entity is not found.

Return The DataReference of the GoodnessOfFit.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 249
Design Exploration

Type DataReference

Required Arguments

Name Name of the GoodnessOfFit.

Type string

Example
The following example shows how the user can get a GoodnessOfFit.

system1 = GetSystem(Name="RSO")
responseSurface1 = system1.GetContainer(ComponentName="Response Surface")
responseSurfaceModel1 = responseSurface1.GetModel()
gof = responseSurfaceModel1.GetGoodnessOfFit(Name="GoodnessOfFit")

GetGoodnessOfFits

Get the DataReferences of the GoodnessOfFit entities associated with a Model.

Return The DataReferences of the GoodnessOfFits.

Type DataReferenceSet

Example
The following example shows how to retrieve the GoodnessOfFit entities of a response surface model.

system1 = GetSystem(Name="RSO")
responseSurface1 = system1.GetContainer(ComponentName="Response Surface")
responseSurfaceModel1 = responseSurface1.GetModel()
gof = responseSurfaceModel1.GetGoodnessOfFits()

GetMinMaxSearch

Get the DataReference of the MinMaxSearch entity associated with a Response Surface model. An ex-
ception is thrown if the entity is not found.

Return The DataReference of the MinMaxSearch entity.

Type DataReference

Example
The following example shows how the user can get the MinMaxSearch of a ResponseSurfaceModel to
change one of its properties.

responseSurface1 = system1.GetContainer(ComponentName="Response Surface")

responseSurfaceModel1 = responseSurface1.GetModel()
minMaxSearch1 = responseSurfaceModel1.GetMinMaxSearch()
minMaxSearch1.NumberInitialPoints = 200

GetParameter

Get the DataReference of a Parameter. An exception is thrown if the entity is not found.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
250 of ANSYS, Inc. and its subsidiaries and affiliates.
Return The DataReference of the Parameter.

Type DataReference

Required Arguments

Name Name of the Parameter.

Type string

Example
The following example shows how the user can get a parameter of a model to change one of its properties.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
inputParameter1 = dOEModel1.GetParameter(Name="P1")
inputParameter1.LowerBound = 1

GetParameters

Get the DataReferences of the InputParameter and OutputParameter of the model. If the optional argu-
ment InputParameters is not specified, the query returns all parameters. If it is specified and True, the
query returns only input parameters. If it is False, the query returns only output parameters.

Return The DataReferences of the Parameters

Type DataReferenceSet

Optional Arguments

InputParameters If True, the query returns only input parameters. If False, the query returns only output
parameters. If the argument is ommitted, the query returns all parameters.

Type bool

Example
The following example shows how the user can get the parameters of a model.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parameters = dOEModel1.GetParameters()

GetParametricTable

Get the DataReference of ParametricTable. An exception is thrown if the entity is not found. Names of
the tables generated internally are: "DesignPoints", "CorrelationMatrix", "CorrelationScatter", "MinDesign-
Points", "MaxDesignPoints", "ResponsePoints", "DeterminationMatrix".

Return The DataReference of the ParametricTable

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 251
Design Exploration

Required Arguments

Name Name of the ParametricTable

Type string

Example
The following example shows how the user can get a ParametricTable to add a new row and set values.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
parametricTable.AddRow()
parametricTable.SetCellValue(RowIndex=9,ColumnIndex=0,Value="2.1")

GetResponsePoint

Get the DataReference of a ResponsePoint. An exception is thrown if the entity is not found.

Return The DataReference of the ResponsePoint.

Type DataReference

Required Arguments

Name Name

Type string

Example
The following example shows how to retrieve an existing ResponsePoint.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
rp = model.GetResponsePoint(Name="Response Point 1")

GetResponsePoints

Get the DataReferences of the ResponsePoints.

Return The DataReferences of the ResponsePoints

Type DataReferenceSet

Example
The following example shows how to retrieve the response points of a response surface model.

system1 = GetSystem(Name="RSO")
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
responsePoints = model.GetResponsePoints()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
252 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportRefinementPointsFromFile

Import Refinement Point values in the manual refinement table of a Response Surface model from a
csv file.

Required Arguments

FileName The imported file name.

Type string

Example
The following example shows how the user can import refinement points from a valid csv file.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
model.ImportRefinementPointsFromFile(FilePath="designs.csv")

ImportVerificationPointsFromFile

Import Verification Point values in the verification table of a Response Surface model from a csv file.

Required Arguments

FileName The imported file name.

Type string

Example
The following example shows how the user can import verification points from a valid csv file.

container = system1.GetContainer(ComponentName="Response Surface")

model = container.GetModel()
model.ImportVerificationPointsFromFile(FilePath="designs.csv")

PreviewDesignPoints

Previews the Design Points of a model, without actually updating them, so that the user can adjust
settings before launching a long update operation. This command applies to a Design of Experiments
model, or the Refinement Points of a Kriging Response Surface, or a Parameters Correlation model. The
command returns the table of the generated points.

Return The DataReference of the ParametricTable containing the generated data.

Type DataReference

Example
The following example shows how to preview a DOE model.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DOEMatrix = model.PreviewDesignPoints()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 253
Design Exploration

DX Parameters Correlation
This container holds data for a Parameter Correlation.

Methods
GetModel
Get the DataReference of the Model. An exception is thrown if the entity is not found.

Return The DataReference of the Model.

Type DataReference

Example
The following example shows how the user can get a Model to change one of its properties.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
dOEModel1.DOEType = "eDOETYPE_OSFD"

Data Entities
CorrelationModel
Entity which performs and manages the DesignXplorer Parameters Correlation Component

Properties
AutoStopType

Auto Stop Type

Type CorrelationAutoStopType

Read Only No

Converged

Convergence state

Type bool

Read Only Yes

ConvergenceCheckFrequency

Convergence Check Frequency

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
254 of ANSYS, Inc. and its subsidiaries and affiliates.
CorrelationFiltering

True to filter input parameters based on the correlation values

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ExportDesignPoints

If True and PreserveDesignPoints is True as well, export project for each preserved Design Point.

Type bool

Read Only No

LinearCorrelationType

Correlation Type

Type LinearCorrelationType

Read Only No

MaximumNumberMajorInputs

Maximum Number of Major Input Parameters

Type int

Read Only No

MeanValueAccuracy

Mean Value Accuracy

Type double

Read Only No

NumberOfRetries

Indicates the number of times DX will try to update the failed design points.

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 255
Design Exploration

NumberSamples

Number of Samples

Type int

Read Only No

PreserveDesignPoints

If True, preserve the Design Points at the project level after the component Update.

Type bool

Read Only No

R2ContributionFiltering

True to filter input parameters based on the gain in prediction

Type bool

Read Only No

RelevanceThreshold

Relevance threshold for the parameters filtering

Type double

Read Only No

RestartMode

True to reuse the samples already generated

Type bool

Read Only No

RetainDesignPoints

If True and PreserveDesignPoints is True as well, retain data for each preserved Design Point.

Type bool

Read Only No

RetryDelay

Indicates how much time will elapse between tries. This option is only applicable when NumberOfRetries
is greater than 0, otherwise it has no effect.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
256 of ANSYS, Inc. and its subsidiaries and affiliates.
SampleSetSize

Size of Generated Sample Set

Type int

Read Only Yes

StandardDeviationAccuracy

Standard Deviation Accuracy

Type double

Read Only No

Methods
CreateChart

Creates a Chart entity. The chart must be updated once after its creation by invoking its Update method.
Then changes to its properties will update the chart automatically.

Return The DataReference of the Chart.

Type DataReference

Required Arguments

ChartType Type of chart to be created. The possible values depend on the type of Model. For instance, a
ResponseSurface model accepts Spider, LocalSensitivity and Response chart while a Correla-
tionModel accepts CorrelationMatrix, DeterminationMatrix and CorrelationScatter charts.

Type ChartType

Optional Arguments

DisplayText Displayed name of the chart. If not specified, a default name is applied, depending on the
value of ChartType.

Type string

Example
The following example shows how to create a chart.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
TradeoffChart = model.CreateChart(ChartType="eChartTradeoff")
TradeoffChart.Update()

DeleteCharts

Deletes a list of Chart entities.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 257
Design Exploration

Required Arguments

Charts List of Chart entities to delete.

Type List<DataReference>

Example
The following example shows how to delete existing charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart1 = model.GetChart(Name="TradeoffChart 1")
chart2 = model.GetChart(Name="SamplesChart 1")
model.DeleteCharts(Charts=[chart1, chart2])

DuplicateChart

Duplicates a Chart entity. The chart must be updated once after its creation by invoking its Update
method. Then changes to its properties will update the chart automatically.

Return The DataReference of the Chart.

Type DataReference

Required Arguments

Chart The source chart to duplicate.

Type DataReference

Optional Arguments

DisplayText Displayed name of the chart. If not specified, a default name is applied, depending
on the value of ChartType.

Type string

TargetModel The model on which the duplicated chart is created. If this parameter is not set,
the model of the source chart is used.

Type DataReference

TargetResponsePoint Parent TargetResponsePoint of the chart. If this parameter is not set, the response
point of the source chart is used if applicable.

Type DataReference

Example
The following example shows how to duplicate a chart.

designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")

dOEModel1 = designofExperiment1.GetModel()
designPointsCurvesChart1 = dOEModel1.GetChart(Name="DesignPointsCurves")
chart1 = dOEModel1.DuplicateChart(Chart=designPointsCurvesChart1)
chart1.Update()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
258 of ANSYS, Inc. and its subsidiaries and affiliates.
GetChart

Query to return the chart reference for a given model and chart name.

Return The DataReference of the chart.

Type DataReference

Required Arguments

Name Name of the chart.

Type string

GetParameter

Get the DataReference of a Parameter. An exception is thrown if the entity is not found.

Return The DataReference of the Parameter.

Type DataReference

Required Arguments

Name Name of the Parameter.

Type string

Example
The following example shows how the user can get a parameter of a model to change one of its properties.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
inputParameter1 = dOEModel1.GetParameter(Name="P1")
inputParameter1.LowerBound = 1

GetParameters

Get the DataReferences of the InputParameter and OutputParameter of the model. If the optional argu-
ment InputParameters is not specified, the query returns all parameters. If it is specified and True, the
query returns only input parameters. If it is False, the query returns only output parameters.

Return The DataReferences of the Parameters

Type DataReferenceSet

Optional Arguments

InputParameters If True, the query returns only input parameters. If False, the query returns only output
parameters. If the argument is ommitted, the query returns all parameters.

Type bool

Example
The following example shows how the user can get the parameters of a model.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 259
Design Exploration

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parameters = dOEModel1.GetParameters()

GetParametricTable

Get the DataReference of ParametricTable. An exception is thrown if the entity is not found. Names of
the tables generated internally are: "DesignPoints", "CorrelationMatrix", "CorrelationScatter", "MinDesign-
Points", "MaxDesignPoints", "ResponsePoints", "DeterminationMatrix".

Return The DataReference of the ParametricTable

Type DataReference

Required Arguments

Name Name of the ParametricTable

Type string

Example
The following example shows how the user can get a ParametricTable to add a new row and set values.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
parametricTable.AddRow()
parametricTable.SetCellValue(RowIndex=9,ColumnIndex=0,Value="2.1")

PreviewDesignPoints

Previews the Design Points of a model, without actually updating them, so that the user can adjust
settings before launching a long update operation. This command applies to a Design of Experiments
model, or the Refinement Points of a Kriging Response Surface, or a Parameters Correlation model. The
command returns the table of the generated points.

Return The DataReference of the ParametricTable containing the generated data.

Type DataReference

Example
The following example shows how to preview a DOE model.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DOEMatrix = model.PreviewDesignPoints()

InputParameter
The data entity which describes an Input Parameter in DesignXplorer.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
260 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Attribute1

First editable attribute of the distribution for an uncertainty parameter. The nature of the attribute de-
pends on the distribution type. For instance, the first attribute of a Normal distribution is the Mean
value.

Type double

Read Only No

Attribute2

Second editable attribute of the distribution for an uncertainty parameter. The nature of the attribute
depends on the distribution type. For instance, the second attribute of a Normal distribution is the
Standard Deviation value. Some distribution type do not have a second attribute.

Type double

Read Only No

ConstantValue

Constant value of the Parameter when it is disabled.

Type Object

Read Only No

CustomDefinitionList

Custom Definition List

Type List<DataReference>

Read Only No

DiscreteLevels

List of the discrete levels.

Type List<DataReference>

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 261
Design Exploration

DistributionLowerBound

Distribution lower bound of the variation range for an uncertainty Parameter.

Type double

Read Only No

DistributionType

Distribution type for an uncertainty parameter.

Type DistributionType

Read Only No

DistributionUpperBound

Distribution upper bound of the variation range for an uncertainty Parameter.

Type double

Read Only No

Enabled

True if the Parameter is enabled for the current study.

Type bool

Read Only No

Kurtosis

Kurtosis value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

LowerBound

Lower bound of the variation range for a Continuous Parameter.

Type double

Read Only No

Mean

Mean value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
262 of ANSYS, Inc. and its subsidiaries and affiliates.
Nature

Nature of the Parameter.

Type ParameterNature

Read Only No

NumberOfLevels

Number of levels if the parameter nature is Discrete, or the parameter nature is Continuous and the
UseManufacturableValues property is set to True.

Type int

Read Only Yes

Skewness

Skewness value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

StandardDeviation

Standard deviation value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

Type

Type of the Parameter, either a DesignVariable in a GDO context, or an UncertaintyVariable in a SixSigma

Analysis context.

Type SimulationType

Read Only Yes

Units

Units

Type string

Read Only Yes

UpperBound

Upper bound of the variation range for a Continuous Parameter.

Type double

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 263
Design Exploration

Read Only No

UseManufacturableValues

True to restrict the variation of the parameter to defined Manufacturable Values.

Type bool

Read Only No

Methods
AddDiscreteLevel

Adds a Discrete Level entity on a discrete input parameter. A discrete level can have an integer value
(e.g. a number of holes, a number of turns, etc) or a string value (e.g. a material name or a geometry
file name). The command has optional arguments to specify the Name of the level and its Index in the
list of levels of the parameter. By default, the new level is added to the end of the list. The various discrete
levels of an input parameter represent independent configurations of the project, processed in the order
of their creation.

Return The created entity.

Type DataReference

Required Arguments

Value The value of the discrete level. Value can be an integer or a string.

Type Object

Optional Arguments

DisplayText DisplayText of the created entity. If not specified, a default name of the form "Level [#]" is
used.

Type string

Index The position of the new level in the list of discrete levels of the parameter. Index is zero-
based. If it is not specified, the new level is appended to the list.

Type int

Default Value -1

Example
The following example shows how to add new discrete levels on a discrete input parameter. The third
level is inserted between the two others.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DiscreteInputParameter = model.GetParameter(Name="P2")
DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
264 of ANSYS, Inc. and its subsidiaries and affiliates.
AddLevels

Adds a list of levels to a continuous input parameter. Each level is a quantity or a real number corres-
ponding to a manufacturable value. The list of levels forms a restriction filter used when post-processing
the input parameter. If levels are added outside of the variation range, the lower and upper bounds
are adjusted accordingly.

Required Arguments

Levels List of added levels.

Type List<string>

Optional Arguments

Overwrite True in order to overwrite the existing levels, False by default.

Type bool

Example
The following example shows how to overwrite the manufacturable values of an input parameter and how
to define an additional value later.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
InputParameter = model.GetParameter(Name="P1")
InputParameter.UseManufacturableValues = True
InputParameter.AddLevels(Levels=["0.3 [mm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
InputParameter.AddLevels(Levels="7 [mm]")

CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter The parameter on which the criterion is created.

Type DataReference

Example
The following example shows how to create an OptimizationCriterion entity.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameter1 = model.GetParameter(Name="P1")
optimizationCriterion = parameter1.CreateOptimizationCriterion()

DeleteDiscreteLevels

Deletes a list of levels from a discrete input parameter.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 265
Design Exploration

Required Arguments

DiscreteLevels List of the DiscreteLevel entities to delete.

Type List<DataReference>

Example
The following example shows how to add and then delete one or more levels from a discrete input para-
meter.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DiscreteInputParameter = model.GetParameter(Name="P1")
level1 = DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
level2 = DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
level3 = DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")
DiscreteInputParameter.DeleteDiscreteLevels(DiscreteLevels=[level1, level2])

DeleteLevels

Deletes a list of levels from a continuous input parameter.

Required Arguments

Indices Indices of the items to remove from the levels list

Type List<int>

Example
The following example shows how to add and then delete one or more levels from a continuous input
parameter for which the UseManufacturableValues property is set to True.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
InputParameter = model.GetParameter(Name="P1")
InputParameter.UseManufacturableValues = True
InputParameter.AddLevels(Levels=["0.3 [mmm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
InputParameter.DeleteLevels( Indices=[0, 1] )

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
266 of ANSYS, Inc. and its subsidiaries and affiliates.
 Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

GetCustomParameterDefinition

Get the DataReference of a CustomParameterProperties entity associated with an Input Parameter. An

exception is thrown if the entity is not found.

Return The DataReference of the CustomParameterProperties.

Type DataReference

Required Arguments

ExtensionName Extension's Name.

Type string

Example
The following example shows how the user can get a CustomParameterProperties.

system1 = GetSystem(Name="DOP")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
inputParameter1 = optimizationModel1.GetParameter(Name="P1")
customParameterDefinition1 = inputParameter1.GetCustomParameterDefinition(ExtensionName="UncertaintyParamet
customParameterDefinition1.Distribution = "Triangular"

GetDiscreteLevel

Get a discrete level by name from an input parameter. The parameter's full and ordered list of discrete
levels is available as its "DiscreteLevels" property.

Return The DataReference of the discrete level entity.

Type DataReference

Required Arguments

Name The name of the discrete level.

Type string

Example
The following example shows how the user can retrieve a discrete level of a discrete input parameter by
its name.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 267
Design Exploration

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
DiscreteInputParameter1 = dOEModel1.GetParameter(Name="P1")
level = DiscreteInputParameter1.GetDiscreteLevel(Name="Level 1")

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown
if the entity is not found.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter Parent Parameter.

Type DataReference

Example
The following example shows how the user can get a OptimizationCriterion to change one of its properties.

system1 = GetSystem(Name="RSO")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
parameter3 = optimizationModel1.GetParameter(Name="P3")
optimizationCriterion = parameter3.GetOptimizationCriterion()
optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return The DataReference of the ParameterStatistics entity.

Type DataReference

Example
The following example shows how the user can get a ParameterStatistics entity and examine its Mean
property.

system1 = GetSystem(Name="SSA")
sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
parameter4 = sixSigmaModel1.GetParameter(Name="P4")
parameterStatistics1 = parameter4.GetParameterStatistics()
mean = parameterStatistics1.Mean

OutputParameter
Output parameter entity for DesignXplorer.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
268 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IgnoreForFiltering

Determines whether the parameter filtering is not applicable to the output parameter in the correlation
context.

Type bool

Read Only No

InheritFromModelSettings

Determines whether the Maximum Predicted Relative Error defined at the Model level is applicable to
the output parameter.

Type bool

Read Only No

LowerBound

Minimum value extracted from existing design points and/or sample sets.

Type double

Read Only Yes

MaxPredictedRelativeError

Maximum Relative Error targeted for an output parameter when refining with the Kriging algorithm.
This is the maximum predicted relative error that is acceptable for the selected output parameter.

Type double

Read Only No

PredictedRelativeError

Current value of the Predicted Relative Error when refining with the Kriging algorithm

Type double

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 269
Design Exploration

TransformationType

Transformation Type

Type TransformationType

Read Only No

Units

Units

Type string

Read Only Yes

UpperBound

Maximum value extracted from existing design points and/or sample sets.

Type double

Read Only Yes

Methods
CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter The parameter on which the criterion is created.

Type DataReference

Example
The following example shows how to create an OptimizationCriterion entity.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameter1 = model.GetParameter(Name="P1")
optimizationCriterion = parameter1.CreateOptimizationCriterion()

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown
if the entity is not found.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
270 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Parameter Parent Parameter.

Type DataReference

Example
The following example shows how the user can get a OptimizationCriterion to change one of its properties.

system1 = GetSystem(Name="RSO")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
parameter3 = optimizationModel1.GetParameter(Name="P3")
optimizationCriterion = parameter3.GetOptimizationCriterion()
optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return The DataReference of the ParameterStatistics entity.

Type DataReference

Example
The following example shows how the user can get a ParameterStatistics entity and examine its Mean
property.

system1 = GetSystem(Name="SSA")
sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
parameter4 = sixSigmaModel1.GetParameter(Name="P4")
parameterStatistics1 = parameter4.GetParameterStatistics()
mean = parameterStatistics1.Mean

DX Six Sigma Analysis

This container holds data for a Six Sigma Analysis.

Methods
GetModel
Get the DataReference of the Model. An exception is thrown if the entity is not found.

Return The DataReference of the Model.

Type DataReference

Example
The following example shows how the user can get a Model to change one of its properties.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 271
Design Exploration

dOEModel1 = designofExperiment1.GetModel()
dOEModel1.DOEType = "eDOETYPE_OSFD"

Data Entities
InputParameter
The data entity which describes an Input Parameter in DesignXplorer.

Properties
Attribute1

First editable attribute of the distribution for an uncertainty parameter. The nature of the attribute de-
pends on the distribution type. For instance, the first attribute of a Normal distribution is the Mean
value.

Type double

Read Only No

Attribute2

Second editable attribute of the distribution for an uncertainty parameter. The nature of the attribute
depends on the distribution type. For instance, the second attribute of a Normal distribution is the
Standard Deviation value. Some distribution type do not have a second attribute.

Type double

Read Only No

ConstantValue

Constant value of the Parameter when it is disabled.

Type Object

Read Only No

CustomDefinitionList

Custom Definition List

Type List<DataReference>

Read Only No

DiscreteLevels

List of the discrete levels.

Type List<DataReference>

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
272 of ANSYS, Inc. and its subsidiaries and affiliates.
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

DistributionLowerBound

Distribution lower bound of the variation range for an uncertainty Parameter.

Type double

Read Only No

DistributionType

Distribution type for an uncertainty parameter.

Type DistributionType

Read Only No

DistributionUpperBound

Distribution upper bound of the variation range for an uncertainty Parameter.

Type double

Read Only No

Enabled

True if the Parameter is enabled for the current study.

Type bool

Read Only No

Kurtosis

Kurtosis value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

LowerBound

Lower bound of the variation range for a Continuous Parameter.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 273
Design Exploration

Mean

Mean value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

Nature

Nature of the Parameter.

Type ParameterNature

Read Only No

NumberOfLevels

Number of levels if the parameter nature is Discrete, or the parameter nature is Continuous and the
UseManufacturableValues property is set to True.

Type int

Read Only Yes

Skewness

Skewness value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

StandardDeviation

Standard deviation value of the distribution for an uncertainty parameter.

Type double

Read Only Yes

Type

Type of the Parameter, either a DesignVariable in a GDO context, or an UncertaintyVariable in a SixSigma

Analysis context.

Type SimulationType

Read Only Yes

Units

Units

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
274 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only Yes

UpperBound

Upper bound of the variation range for a Continuous Parameter.

Type double

Read Only No

UseManufacturableValues

True to restrict the variation of the parameter to defined Manufacturable Values.

Type bool

Read Only No

Methods
AddDiscreteLevel

Adds a Discrete Level entity on a discrete input parameter. A discrete level can have an integer value
(e.g. a number of holes, a number of turns, etc) or a string value (e.g. a material name or a geometry
file name). The command has optional arguments to specify the Name of the level and its Index in the
list of levels of the parameter. By default, the new level is added to the end of the list. The various discrete
levels of an input parameter represent independent configurations of the project, processed in the order
of their creation.

Return The created entity.

Type DataReference

Required Arguments

Value The value of the discrete level. Value can be an integer or a string.

Type Object

Optional Arguments

DisplayText DisplayText of the created entity. If not specified, a default name of the form "Level [#]" is
used.

Type string

Index The position of the new level in the list of discrete levels of the parameter. Index is zero-
based. If it is not specified, the new level is appended to the list.

Type int

Default Value -1

Example
The following example shows how to add new discrete levels on a discrete input parameter. The third
level is inserted between the two others.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 275
Design Exploration

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DiscreteInputParameter = model.GetParameter(Name="P2")
DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")

AddLevels

Adds a list of levels to a continuous input parameter. Each level is a quantity or a real number corres-
ponding to a manufacturable value. The list of levels forms a restriction filter used when post-processing
the input parameter. If levels are added outside of the variation range, the lower and upper bounds
are adjusted accordingly.

Required Arguments

Levels List of added levels.

Type List<string>

Optional Arguments

Overwrite True in order to overwrite the existing levels, False by default.

Type bool

Example
The following example shows how to overwrite the manufacturable values of an input parameter and how
to define an additional value later.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
InputParameter = model.GetParameter(Name="P1")
InputParameter.UseManufacturableValues = True
InputParameter.AddLevels(Levels=["0.3 [mm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
InputParameter.AddLevels(Levels="7 [mm]")

CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter The parameter on which the criterion is created.

Type DataReference

Example
The following example shows how to create an OptimizationCriterion entity.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
276 of ANSYS, Inc. and its subsidiaries and affiliates.
 parameter1 = model.GetParameter(Name="P1")
optimizationCriterion = parameter1.CreateOptimizationCriterion()

DeleteDiscreteLevels

Deletes a list of levels from a discrete input parameter.

Required Arguments

DiscreteLevels List of the DiscreteLevel entities to delete.

Type List<DataReference>

Example
The following example shows how to add and then delete one or more levels from a discrete input para-
meter.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
DiscreteInputParameter = model.GetParameter(Name="P1")
level1 = DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
level2 = DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
level3 = DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")
DiscreteInputParameter.DeleteDiscreteLevels(DiscreteLevels=[level1, level2])

DeleteLevels

Deletes a list of levels from a continuous input parameter.

Required Arguments

Indices Indices of the items to remove from the levels list

Type List<int>

Example
The following example shows how to add and then delete one or more levels from a continuous input
parameter for which the UseManufacturableValues property is set to True.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
InputParameter = model.GetParameter(Name="P1")
InputParameter.UseManufacturableValues = True
InputParameter.AddLevels(Levels=["0.3 [mmm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
InputParameter.DeleteLevels( Indices=[0, 1] )

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart
entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName The exported file name.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 277
Design Exploration

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the table of Design Points and then the Parameters
Parallel chart of a Design of Experiments component.

container = system1.GetContainer(ComponentName="Design of Experiment")

model = container.GetModel()
parametricTable = model.GetParametricTable(Name="DesignPoints")
parametricTable.ExportData(FileName="doe.csv")
chart = model.GetChart(Name="DesignPointsParallel")
chart.ExportData(FileName="doe.csv", AppendMode=True)

GetCustomParameterDefinition

Get the DataReference of a CustomParameterProperties entity associated with an Input Parameter. An

exception is thrown if the entity is not found.

Return The DataReference of the CustomParameterProperties.

Type DataReference

Required Arguments

ExtensionName Extension's Name.

Type string

Example
The following example shows how the user can get a CustomParameterProperties.

system1 = GetSystem(Name="DOP")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
inputParameter1 = optimizationModel1.GetParameter(Name="P1")
customParameterDefinition1 = inputParameter1.GetCustomParameterDefinition(ExtensionName="UncertaintyParamet
customParameterDefinition1.Distribution = "Triangular"

GetDiscreteLevel

Get a discrete level by name from an input parameter. The parameter's full and ordered list of discrete
levels is available as its "DiscreteLevels" property.

Return The DataReference of the discrete level entity.

Type DataReference

Required Arguments

Name The name of the discrete level.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
278 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Example
The following example shows how the user can retrieve a discrete level of a discrete input parameter by
its name.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
DiscreteInputParameter1 = dOEModel1.GetParameter(Name="P1")
level = DiscreteInputParameter1.GetDiscreteLevel(Name="Level 1")

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown
if the entity is not found.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter Parent Parameter.

Type DataReference

Example
The following example shows how the user can get a OptimizationCriterion to change one of its properties.

system1 = GetSystem(Name="RSO")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
parameter3 = optimizationModel1.GetParameter(Name="P3")
optimizationCriterion = parameter3.GetOptimizationCriterion()
optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return The DataReference of the ParameterStatistics entity.

Type DataReference

Example
The following example shows how the user can get a ParameterStatistics entity and examine its Mean
property.

system1 = GetSystem(Name="SSA")
sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
parameter4 = sixSigmaModel1.GetParameter(Name="P4")
parameterStatistics1 = parameter4.GetParameterStatistics()
mean = parameterStatistics1.Mean

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 279
Design Exploration

OutputParameter
Output parameter entity for DesignXplorer.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IgnoreForFiltering

Determines whether the parameter filtering is not applicable to the output parameter in the correlation
context.

Type bool

Read Only No

InheritFromModelSettings

Determines whether the Maximum Predicted Relative Error defined at the Model level is applicable to
the output parameter.

Type bool

Read Only No

LowerBound

Minimum value extracted from existing design points and/or sample sets.

Type double

Read Only Yes

MaxPredictedRelativeError

Maximum Relative Error targeted for an output parameter when refining with the Kriging algorithm.
This is the maximum predicted relative error that is acceptable for the selected output parameter.

Type double

Read Only No

PredictedRelativeError

Current value of the Predicted Relative Error when refining with the Kriging algorithm

Type double

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
280 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only Yes

TransformationType

Transformation Type

Type TransformationType

Read Only No

Units

Units

Type string

Read Only Yes

UpperBound

Maximum value extracted from existing design points and/or sample sets.

Type double

Read Only Yes

Methods
CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return The DataReference of the OptimizationCriterion.

Type DataReference

Required Arguments

Parameter The parameter on which the criterion is created.

Type DataReference

Example
The following example shows how to create an OptimizationCriterion entity.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameter1 = model.GetParameter(Name="P1")
optimizationCriterion = parameter1.CreateOptimizationCriterion()

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown
if the entity is not found.

Return The DataReference of the OptimizationCriterion.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 281
Design Exploration

Type DataReference

Required Arguments

Parameter Parent Parameter.

Type DataReference

Example
The following example shows how the user can get a OptimizationCriterion to change one of its properties.

system1 = GetSystem(Name="RSO")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
parameter3 = optimizationModel1.GetParameter(Name="P3")
optimizationCriterion = parameter3.GetOptimizationCriterion()
optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return The DataReference of the ParameterStatistics entity.

Type DataReference

Example
The following example shows how the user can get a ParameterStatistics entity and examine its Mean
property.

system1 = GetSystem(Name="SSA")
sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
parameter4 = sixSigmaModel1.GetParameter(Name="P4")
parameterStatistics1 = parameter4.GetParameterStatistics()
mean = parameterStatistics1.Mean

SixSigmaModel
Entity which performs and manages the Six Sigma Analysis Component

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ExportDesignPoints

If True and PreserveDesignPoints is True as well, export project for each preserved Design Point.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
282 of ANSYS, Inc. and its subsidiaries and affiliates.
Type bool

Read Only No

NumberOfRetries

Indicates the number of times DX will try to update the failed design points.

Type int

Read Only No

NumSamp

Number of Samples

Type int

Read Only No

PreserveDesignPoints

If True, preserve the Design Points at the project level after the component Update.

Type bool

Read Only No

RetainDesignPoints

If True and PreserveDesignPoints is True as well, retain data for each preserved Design Point.

Type bool

Read Only No

RetryDelay

Indicates how much time will elapse between tries. This option is only applicable when NumberOfRetries
is greater than 0, otherwise it has no effect.

Type Quantity

Read Only No

SampleGenType

Sampling Type

Type SampleGenType

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 283
Design Exploration

Methods
CreateChart

Creates a Chart entity. The chart must be updated once after its creation by invoking its Update method.
Then changes to its properties will update the chart automatically.

Return The DataReference of the Chart.

Type DataReference

Required Arguments

ChartType Type of chart to be created. The possible values depend on the type of Model. For instance, a
ResponseSurface model accepts Spider, LocalSensitivity and Response chart while a Correla-
tionModel accepts CorrelationMatrix, DeterminationMatrix and CorrelationScatter charts.

Type ChartType

Optional Arguments

DisplayText Displayed name of the chart. If not specified, a default name is applied, depending on the
value of ChartType.

Type string

Example
The following example shows how to create a chart.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
TradeoffChart = model.CreateChart(ChartType="eChartTradeoff")
TradeoffChart.Update()

DeleteCharts

Deletes a list of Chart entities.

Required Arguments

Charts List of Chart entities to delete.

Type List<DataReference>

Example
The following example shows how to delete existing charts.

container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
chart1 = model.GetChart(Name="TradeoffChart 1")
chart2 = model.GetChart(Name="SamplesChart 1")
model.DeleteCharts(Charts=[chart1, chart2])

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
284 of ANSYS, Inc. and its subsidiaries and affiliates.
DuplicateChart

Duplicates a Chart entity. The chart must be updated once after its creation by invoking its Update
method. Then changes to its properties will update the chart automatically.

Return The DataReference of the Chart.

Type DataReference

Required Arguments

Chart The source chart to duplicate.

Type DataReference

Optional Arguments

DisplayText Displayed name of the chart. If not specified, a default name is applied, depending
on the value of ChartType.

Type string

TargetModel The model on which the duplicated chart is created. If this parameter is not set,
the model of the source chart is used.

Type DataReference

TargetResponsePoint Parent TargetResponsePoint of the chart. If this parameter is not set, the response
point of the source chart is used if applicable.

Type DataReference

Example
The following example shows how to duplicate a chart.

designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")

dOEModel1 = designofExperiment1.GetModel()
designPointsCurvesChart1 = dOEModel1.GetChart(Name="DesignPointsCurves")
chart1 = dOEModel1.DuplicateChart(Chart=designPointsCurvesChart1)
chart1.Update()

GetChart

Query to return the chart reference for a given model and chart name.

Return The DataReference of the chart.

Type DataReference

Required Arguments

Name Name of the chart.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 285
Design Exploration

GetParameter

Get the DataReference of a Parameter. An exception is thrown if the entity is not found.

Return The DataReference of the Parameter.

Type DataReference

Required Arguments

Name Name of the Parameter.

Type string

Example
The following example shows how the user can get a parameter of a model to change one of its properties.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
inputParameter1 = dOEModel1.GetParameter(Name="P1")
inputParameter1.LowerBound = 1

GetParameters

Get the DataReferences of the InputParameter and OutputParameter of the model. If the optional argu-
ment InputParameters is not specified, the query returns all parameters. If it is specified and True, the
query returns only input parameters. If it is False, the query returns only output parameters.

Return The DataReferences of the Parameters

Type DataReferenceSet

Optional Arguments

InputParameters If True, the query returns only input parameters. If False, the query returns only output
parameters. If the argument is ommitted, the query returns all parameters.

Type bool

Example
The following example shows how the user can get the parameters of a model.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parameters = dOEModel1.GetParameters()

GetParametricTable

Get the DataReference of ParametricTable. An exception is thrown if the entity is not found. Names of
the tables generated internally are: "DesignPoints", "CorrelationMatrix", "CorrelationScatter", "MinDesign-
Points", "MaxDesignPoints", "ResponsePoints", "DeterminationMatrix".

Return The DataReference of the ParametricTable

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
286 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataReference

Required Arguments

Name Name of the ParametricTable

Type string

Example
The following example shows how the user can get a ParametricTable to add a new row and set values.

system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
parametricTable.AddRow()
parametricTable.SetCellValue(RowIndex=9,ColumnIndex=0,Value="2.1")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 287
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
288 of ANSYS, Inc. and its subsidiaries and affiliates.
Engineering Data

Engineering Data
The container used by an Engineering Data component to maintain project data.

Methods
AddToProjectDefaults
Adds an item, to the list of items, that will be added to new projects by default.

The item must be a favorite before it can be added to project defaults.

Required Arguments

Source The source of material to be added to the project defaults.

Type string

Optional Arguments

ItemType The EngineeringDataType of the item. This can be Material, Load, or BeamSection.

Type string

Default Value Material

Example
The following example shows how to add a material named Concrete to the project defaults.

installDir = r"C:\Program Files\ANSYS Inc\v121"

EngData.AddToProjectDefaults(Name="Concrete",
Source=installDir+r"\Addins\EngineeringData\Samples\General_Materials.xml"
ItemType="Material")

CreateMaterial
Adds a new material to the container.

Return The material data reference of the new material.

Type DataReference

Required Arguments

Name The name to be used for this material.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 289
Engineering Data

Type string

Export
Exports engineering data to the specified file.

The following type of file format is supported for export:

MatML 3.1 schema for Material(s)

Required Arguments

FilePath The target path for the Engineering Data file ("*.xml").

Type string

Format The file format in which engineering data will be exported.

Type string

UnitSystem The unit system in which engineering data will be exported.

Type string

Optional Arguments

ApplyScaleOffset The flag to specify if the scale factor and offset value will be applied during export.

Type bool

Default Value False

IgnoreSuppressed The flag to specify if suppressed engineering data will be ignored during export.

Type bool

Default Value False

OverwriteTarget The flag to specify if the target file will be overwritten.

Type bool

Default Value False

ReplaceMaterial The flag to specify if the earlier material data will be replaced in case of similar mater-
ial names.

Type bool

Default Value False

Example
template = GetTemplate(TemplateName="EngData") system = template.CreateSystem(Position="Default")
container = system.GetContainer(ComponentName="Engineering Data") materials = container.GetMater-
ials() EngData.WriteMaterials(MaterialList=materials, FilePath=r"d:\data\OutputMaterials.xml",
Format="MatML31", UnitSystem="MKS_STANDARD", ReplaceMaterial=true)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
290 of ANSYS, Inc. and its subsidiaries and affiliates.
GetMaterial
Returns a material of a given name from a container.

The name matching is case insensitive. If a material is not found an exception is thrown.

Return The material that matches the specified name.

Type DataReference

Required Arguments

Name The name of the material. This argument is case insensitive.

Type string

Example
The following example creates a new Engineering Data system and queries the default material, Structural
Steel.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem(Position="Default")
container = system.GetContainer(ComponentName="Engineering Data")
structuralSteel = container.GetMaterial(Name="Structural Steel")

GetMaterials
Returns the list of materials in a container. If no materials are in the container, the list is empty.

Return A DataReferenceSet of the materials in the container.

Type DataReferenceSet

Import
Imports engineering data into an existing source from a specified source.

The following types of files are supported for import:

Engineering Data libraries exported from Workbench 9.0 to 11.0 SP1

Material(s) file following the MatML 3.1 schema
Material(s) file generated by AUTODYN

Required Arguments

Source The source which contains the materials.

Type string

ImportMaterial
Reads the data for a single material into the requested container.

Return A DataReference for the material that was read.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 291
Engineering Data

Type DataReference

Required Arguments

Name The name of the material to read from the source.

Type string

Source The source which contains the requested material.

Type string

Example
This code shows how to read the Copper Alloy material from the provided samples, into Engineering Data
to use in an analysis.

installDir = r"C:\Program Files\ANSYS Inc\v121"

matl1 = engineeringData1.ReadMaterial(
Name="Copper Alloy",
Source=installDir+r"\Addins\EngineeringData\Samples\General_Materials.xml")

RemoveFromProjectDefaults
Removes an item, from the list of items, that are added to new projects by default.

Required Arguments

Source The path to the file containing the item to remove.

Type string

Optional Arguments

ItemType The EngineeringDataType of the item. This can be Material, Load, or BeamSection.

Type string

Default Value Material

Example
The following example shows how to remove Concrete from project defaults.

installDir = r"C:\Program Files\ANSYS Inc\v121"

EngData.RemoveFromProjectDefaults(Name="Concrete",
Source=installDir+r"\Addins\EngineeringData\Samples\General_Materials.xml"
ItemType="Material")

Data Entities
CurveFit
The entity to store curve fitting information.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
292 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
CurveFitData

The coefficients of material model that approximates the experimental test data.

Type DataReference

Read Only No

DependentPropertyColl

The collection of experimental test data, e.g., Uniaxial Test data (Engineering Strain Vs Engineering
Stress).

Type DataReferenceSet

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

UnitSystemWhenSolved

The unit system of the coefficients of material model.

Type string

Read Only No

Methods
AddTestData

Adds test data from a given curve fitting.

Required Arguments

TestData The test data property to add.

Type DataReference

Example
The following example loads a material with experimental test data and a Neo-Hookean hyperelastic
property.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem()
engineeringData = system.GetContainer(ComponentName="Engineering Data")
neopreneRubber = engineeringData.ReadMaterial(

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 293
Engineering Data

Name="Neoprene Rubber",
Source="Hyperelastic_Materials.xml")
neoHookeanProperty = neopreneRubber.GetProperty(Name="Neo-Hookean")
neoHookeanPropertyData = neoHookeanProperty.GetPropertyData(Name="Neo-Hookean")
curveFit = neoHookeanPropertyData.CreateCurveFitting(
Type="Neo-Hookean",
Definition="")
uniaxialProperty = neopreneRubber.GetProperty(Name="Uniaxial Test Data")
curveFit.AddTestData(TestData=uniaxialProperty)
biaxialProperty = neopreneRubber.GetProperty(Name="Biaxial Test Data")
curveFit.AddTestData(TestData=biaxialProperty)
shearProperty = neopreneRubber.GetProperty(Name="Shear Test Data")
curveFit.AddTestData(TestData=shearProperty)
volumetricProperty = neopreneRubber.GetProperty(Name="Volumetric Test Data")
curveFit.AddTestData(TestData=volumetricProperty)
curveFit.RemoveTestData(TestData=uniaxialProperty)
curveFit.AddTestData(TestData=uniaxialProperty)
curveFit.Solve()
curveFit.CopyCoefficients(Destination=neoHookeanPropertyData)
curveFit.Delete()

CopyCoefficients

Copies the fitted coefficients from the curve fitting to the property data provided.

Required Arguments

Destination The property data that will receive the coefficients.

Type DataReference

Example
The following example loads a material with experimental test data and a Neo-Hookean hyperelastic
property.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem()
engineeringData = system.GetContainer(ComponentName="Engineering Data")
neopreneRubber = engineeringData.ReadMaterial(
Name="Neoprene Rubber",
Source="Hyperelastic_Materials.xml")
neoHookeanProperty = neopreneRubber.GetProperty(Name="Neo-Hookean")
neoHookeanPropertyData = neoHookeanProperty.GetPropertyData(Name="Neo-Hookean")
curveFit = neoHookeanPropertyData.CreateCurveFitting(
Type="Neo-Hookean",
Definition="")
uniaxialProperty = neopreneRubber.GetProperty(Name="Uniaxial Test Data")
curveFit.AddTestData(TestData=uniaxialProperty)
biaxialProperty = neopreneRubber.GetProperty(Name="Biaxial Test Data")
curveFit.AddTestData(TestData=biaxialProperty)
shearProperty = neopreneRubber.GetProperty(Name="Shear Test Data")
curveFit.AddTestData(TestData=shearProperty)
volumetricProperty = neopreneRubber.GetProperty(Name="Volumetric Test Data")
curveFit.AddTestData(TestData=volumetricProperty)
curveFit.RemoveTestData(TestData=uniaxialProperty)
curveFit.AddTestData(TestData=uniaxialProperty)
curveFit.Solve()
curveFit.CopyCoefficients(Destination=neoHookeanPropertyData)
curveFit.Delete()

Delete

Deletes a curve fitting.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
294 of ANSYS, Inc. and its subsidiaries and affiliates.
Example
The following example loads a material with experimental test data and a Neo-Hookean hyperelastic
property.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem()
engineeringData = system.GetContainer(ComponentName="Engineering Data")
neopreneRubber = engineeringData.ReadMaterial(
Name="Neoprene Rubber",
Source="Hyperelastic_Materials.xml")
neoHookeanProperty = neopreneRubber.GetProperty(Name="Neo-Hookean")
neoHookeanPropertyData = neoHookeanProperty.GetPropertyData(Name="Neo-Hookean")
curveFit = neoHookeanPropertyData.CreateCurveFitting(
Type="Neo-Hookean",
Definition="")
uniaxialProperty = neopreneRubber.GetProperty(Name="Uniaxial Test Data")
curveFit.AddTestData(TestData=uniaxialProperty)
biaxialProperty = neopreneRubber.GetProperty(Name="Biaxial Test Data")
curveFit.AddTestData(TestData=biaxialProperty)
shearProperty = neopreneRubber.GetProperty(Name="Shear Test Data")
curveFit.AddTestData(TestData=shearProperty)
volumetricProperty = neopreneRubber.GetProperty(Name="Volumetric Test Data")
curveFit.AddTestData(TestData=volumetricProperty)
curveFit.RemoveTestData(TestData=uniaxialProperty)
curveFit.AddTestData(TestData=uniaxialProperty)
curveFit.Solve()
curveFit.CopyCoefficients(Destination=neoHookeanPropertyData)
curveFit.Delete()

GetChartData

Returns a generated graph data for the specified source data.

Valid source data are:

Material Property
Material Property Data

Return The graph data for the specified source data.

Type DataReference

RemoveTestData

Removes test data from a given curve fitting.

Required Arguments

TestData The test data property to add.

Type DataReference

Example
The following example loads a material with experimental test data and a Neo-Hookean hyperelastic
property.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem()
engineeringData = system.GetContainer(ComponentName="Engineering Data")
neopreneRubber = engineeringData.ReadMaterial(

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 295
Engineering Data

Name="Neoprene Rubber",
Source="Hyperelastic_Materials.xml")
neoHookeanProperty = neopreneRubber.GetProperty(Name="Neo-Hookean")
neoHookeanPropertyData = neoHookeanProperty.GetPropertyData(Name="Neo-Hookean")
curveFit = neoHookeanPropertyData.CreateCurveFitting(
Type="Neo-Hookean",
Definition="")
uniaxialProperty = neopreneRubber.GetProperty(Name="Uniaxial Test Data")
curveFit.AddTestData(TestData=uniaxialProperty)
biaxialProperty = neopreneRubber.GetProperty(Name="Biaxial Test Data")
curveFit.AddTestData(TestData=biaxialProperty)
shearProperty = neopreneRubber.GetProperty(Name="Shear Test Data")
curveFit.AddTestData(TestData=shearProperty)
volumetricProperty = neopreneRubber.GetProperty(Name="Volumetric Test Data")
curveFit.AddTestData(TestData=volumetricProperty)
curveFit.RemoveTestData(TestData=uniaxialProperty)
curveFit.AddTestData(TestData=uniaxialProperty)
curveFit.Solve()
curveFit.CopyCoefficients(Destination=neoHookeanPropertyData)
curveFit.Delete()

Solve

The curve fitting module will solve for the coefficients which most nearly approximate the experimental
test data.

CurveFitData
The entity which contains data relevant to the curve fitting solution. It is possible to call GetData on
this

entity after the curve fitting solution to determine coefficients. Also for nonlinear fits the seed values

can be set via this entity.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Methods
DeleteData

Delete a row from a tabular data sheet.

Required Arguments

Index Index of the row to delete.

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
296 of ANSYS, Inc. and its subsidiaries and affiliates.
Optional Arguments

SheetName Name of the sheet to access.

Type string

SheetQualifiers SheetQualifiers is used to pass in the qualifiers to select between multiple sheets witht
the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

Example
The following example illustrates the deletion of a row from a tabular data sheet.

#
# Create a new Engineering Data System and access Structural Steel
#
template1 = GetTemplate(TemplateName="EngData")
system1 = template1.CreateSystem()
engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
#
# Delete the first row in the Density property
#
matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.DeleteTabularDataRow(Index = 0)
#
# Delete the first row in the Coefficient of Thermal Expansion property with optional SheeetNamea nd SheetQ
#
matlProp2 = matl1.GetProperty(Name="Coefficient of Thermal Expansion")
matlProp2.DeleteTabularDataRow(
SheetName="Coefficient of Thermal Expansion",
SheetQualifiers={"Definition Method": "Secant", "Behavior": "Isotropic"},
Index = 0)

GetData

Returns the tabular data associated with the data entity.

Return The returned data in scalar, list, or dictionary format.

Type Object

Optional Arguments

AsDictionary If set to true, the data will be returned as a dictionary where the keys are variable names
and the values are the data for each variable. If set to false, the data will be returned
in scalar or list format without the variable names.

Type bool

Default Value False

ColumnMajor If set to true, the data will be returned in column-major order. If set to false, the data
will be returned in row-major order.

Type bool

Default Value True

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 297
Engineering Data

EndIndex The end index for requesting a subset of the data (zero-based).

Type int

Default Value -2147483647

SheetName Specifies the sheet name when the data contains multiple sheets.

Type string

SheetQualifiers Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.

Type Dictionary<string, string>

StartIndex The start index for requesting a subset of the data (zero-based).

Type int

Default Value 0

Variables Names of the variables for which data is requested (string or list of strings).

Type Object

Example
In this example, all data is requested for the given tabular data entity.

tabData1.GetData()

In this example, all data is requested in row-major order.

tabData1.GetData(ColumnMajor=False)

In this example, all data is requested in dictionary format.

tabData1.GetData(AsDictionary=True)

In this example, data for variables Density and Temperature is requested in dictionary format.

tabData1.GetData(Variables=["Density", "Temperature"], AsDictionary=True)

SetData

Set tabular data associated with the data entity.

Optional Arguments

Data Sets the data using a dictionary form. The keys are the variable names and the values
are the data. The use of this argument is mutually exclusive with "Values" and "Vari-
ables".

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
298 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type Dictionary<string, List<Object>>

Index Specifies the starting location used to set the data (zero-based). A value of -1 indicates
that the data should be appended to the existing data.

Type int

Default Value 0

SheetName Specifies the sheet name when the data contains multiple sheets.

Type string

SheetQualifiers Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.

Type Dictionary<string, string>

Values List of data values set in conjunction with the "Variables" parameter. This parameter
and the "Data" parameter are mutually exclusive.

Type List<List<Object>>

Variables Names of the variables for which data is being set. This parameter and and the "Data"
parameter are mutually exclusive.

Type List<string>

Example

#
# Create a new Engineering Data System and access Structural Steel
#
template1 = GetTemplate(TemplateName="EngData")
system1 = template1.CreateSystem()
engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
#
# Change the value of a simple single-valued property
#
matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.SetData(
Variables="Density",
Values="8500 [kg m^-3]")
#
# Set Temperature-dependent data for Elasticity based
# on lists of variables and values.
matlProp2 = matl1.GetProperty(Name="Elasticity")
temperature = ["400 [K]", "600 [K]", "800 [K]"]
E = ["2e5 [MPa]", "1.9e5 [MPa]", "1.6e5 [MPa]"]
matlProp2.SetData(
Variables = ["Temperature","Young's Modulus"],
Values = [temperature, E])
#
# Change the Temperature for the second table entry.
#
matlProp2.SetData(
Index = 1,
Variables = "Temperature",
Values = "625 [K]")
#
# Set a list for Poisson's Ratio starting at the second table entry.
#

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 299
Engineering Data

matlProp2.SetData(
Index = 1,
Variables = "Poisson's Ratio",
Values = [0.3, 0.3])
#
# Set Temperature-dependent property data for the Coefficient of Thermal Expansion
# using a dictionary. The dictionary key is the Variable name,
# followed by the list of values for the variable.
#
matlProp3 = matl1.GetProperty(Name="Coefficient of Thermal Expansion")
newData = {"Temperature": ["200 [F]","400 [F]","600 [F]","800 [F]","1000 [F]"],
"Coefficient of Thermal Expansion" : ["6.3e-6 [F^-1]", "7.0e-6 [F^-1]",
"7.46e-6 [F^-1]", "7.8e-6 [F^-1]",
"8.04e-6 [F^-1]"]}
matlProp3.SetData(
SheetName="Coefficient of Thermal Expansion",
SheetQualifiers={"Definition Method": "Secant", "Behavior": "Isotropic"},
Data = newData)

SetQualifier

Changes the values of a specifiec qualifier in a data table.

Required Arguments

Qualifier The Qualifier to Set.

Type string

Value The new value.

Type string

Optional Arguments

SheetName The name of the tabular data sheet that contains the qualifier.

Type string

SheetQualifiers SheetQualifiers can be used to pass in the qualifiers to select between multiple
sheets witht the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

VariableName The name of the Variable that contains the qualifier to be changed.

Type string

VariableQualifiers VariableQualifiers can used to pass in the qualifiers to select between multiple
variables witht the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

Example
The following example changes the 'Derive From' setting within an Isotropic Elasticity material property
to be "Bulk Modulus and Poisson's Ratio".

matl1 = engineeringData1.GetMaterial(Name="Structural Steel")

matlProp1 = matl1.GetProperty(Name="Elasticity")
matlProp1.SetQualifier(

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
300 of ANSYS, Inc. and its subsidiaries and affiliates.
 SheetName="Elasticity",
Qualifier="Derive from",
Value="Bulk Modulus and Poisson's Ratio")

Material
The entity to store material information.

Properties
Description

The description of the material.

Type string

Read Only No

DisplayName

The display name of the material.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Source

The path of the material's source file ("*.engd" or "*.xml").

Type string

Read Only Yes

Methods
AddToFavorites

Adds an item to the Favorites item list.

CreateProperty

Includes a physical quantity or the constitutive relation for the physical response of a material. A property
can be visualized as one or more tables of data made up of one or more dependent and independent
variables.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 301
Engineering Data

The material property is created based on the specified optional parameters "Definition" and "Behavior".

Return Created material properly.

Type DataReference

Required Arguments

Name The new material property name.

Type string

Optional Arguments

Behavior The optional string to identify the way in which a new material property will behave.

Behavior of some material properties can be specified in different ways, e.g., Elasticity
can be specified as Isotropic, Orthotropic or Anisotropic.

Type string

Definition The optional string to identify the way in which new material property will be defined.

Some material properties are defined in different ways, e.g., Thermal Expansion can be
defined as Secant Coefficient of Thermal Expansion and Instantaneous Coefficient of
Thermal Expansion.

Type string

Qualifiers The optional dictionary of a qualifier name and it's corresponding value.

Type Dictionary<string, string>

Example
The following example creates a new Engineering Data system and adds Coefficient of Thermal Expansion
and Elasticity material properties to the default material Structural Steel.

Coefficient of Thermal Expansion is created using Secant definition and Orthotropic behavior.
Elasticity is created using Orthotropic behavior.

ENGDTemplate = GetTemplate(TemplateName="EngData")
ENGDSystem = ENGDTemplate.CreateSystem(Position="Default")

ENGDContainer = ENGDSystem.GetContainer(ComponentName="Engineering Data")

StructSteel = ENGDContainer.GetMaterial(Name="Structural Steel")

# Create material properties

CTEProperty = StructSteel.CreateProperty(
Name="Coefficient of Thermal Expansion",
Definition="Secant",
Behavior="Orthotropic")
OrthoElasProperty = StructSteel.CreateProperty(
Name="Elasticity",
Behavior="Orthotropic")

Delete

Deletes the material.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
302 of ANSYS, Inc. and its subsidiaries and affiliates.
Duplicate

Duplicates the data in this material and returns a new material. The name of the new material will be
appended with a numerical value to make it unique.

Return The material data reference of the duplicated material.

Type DataReference

Required Arguments

TargetContainer The duplicated material will be added to this container.

Type DataContainerReference

GetProperty

Returns a material property of a given name from the specified material.

Return The material property that matches the specified name.

Type DataReference

Required Arguments

Name The name of the material property.

Type string

Example
The following example creates new Engineering Data system and queries Coefficient of Thermal Expansion
property of the default material Structural Steel.

ENGDTemplate = GetTemplate(TemplateName="EngData")
ENGDSystem = ENGDTemplate.CreateSystem(Position="Default")

ENGDContainer = ENGDSystem.GetContainer(ComponentName="Engineering Data")

StructSteel = ENGDContainer.GetMaterial(Name="Structural Steel")

# Get material property

CTEProperty = StructSteel.GetProperty(Name="Coefficient of Thermal Expansion")

IsSuppressed

Checks if an entity is suppressed.

Valid entities are:

Material
Material Property
Material Property Data

Return Returns true if the entity is suppressed, false otherwise.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 303
Engineering Data

IsValid

Validates a material data and provides a message in case of invalid data.

Return The flag that indicates if the material is valid.

Type bool

Optional Arguments

Message The validation failure message.

Type Output<string>

Refresh

This will repopulate the contents of a material with data from a given source. The NameInSource
property of a Material will be used to find a match in the source to pull data from. In the event that
NameInSource is not set, the DisplayName property will be used instead.

Note: This operation will cause destruction of any data currently in the material.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem(Position="Default")
container = system.GetContainer(ComponentName="Engineering Data")
structSteel = container.GetMaterial(Name="Structural Steel")
density = structSteel.GetProperty(Name="Density")
density.Delete()
structSteel.UpdateMaterial(Source="General_Materials.xml")
restoredDensity = structSteel.GetProperty(Name="Density")
restoredDensity.SetData(SheetName="", Index=0, Variables=["Density"], Values=[["8000 [kg m^-3]"]])

Required Arguments

Source The path of the source file.

Type string

RemoveFromFavorites

Removes an item from the Favorite items list.

Optional Arguments

Format The format of the file that contains the item.

Type string

Material A DataReference to the Material to delete.

Type DataReference

Name The name of the item to delete.

Type string

Source The location of the file that contains the item on disk.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
304 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Type The type of the object to delete. This is either a Material or a Mixture.

Type EngineeringDataType

Example
The following example gets the list of favorites from Engineering Data. It then selects and deletes the "Gray
Cast Iron" material from the list.

favorites = EngData.LoadFavoriteItems()
matl = favorites.GetMaterial(Name="Gray Cast Iron")
EngData.DeleteFromFavorites(
Material=matl,
Type="Material")

SetAsDefaultFluidForModel

This will specify the material to use (or not use) for parts in the model which are marked as a fluid.

If the material is in the Engineering Data component it will set or unset the material to be used in the
model component of the system(s) that contain this Engineering Data component.

If the material is contained in Favorites it will set or unset the material to use as the default on fluids
in the Engineering Data component when a new system is added to the project.

The material is set as the default in Favorites. It will automatically be added to the list of project defaults.

Optional Arguments

Default This Boolean is used to set or unset the material as the default.

Type bool

Default Value True

SetAsDefaultSolidForModel

This will specify the material to use (or not use) for parts in the model which are marked as a solid.

If the material is in the Engineering Data component it will set or unset the material to be used in the
model component of the system(s) that contain this Engineering Data component.

If the material is contained in Favorites it will set or unset the material to use as the default on solids
in the Engineering Data component when a new system is added to the project.

The material is set as the default in Favorites. It will automatically be added to the list of project defaults.

Optional Arguments

Default This Boolean is used to set or unset the material as the default.

Type bool

Default Value True

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 305
Engineering Data

SetSuppression

Suppresses or Unsuppresses item.

Item can be suppressed to prevent it from being sent to a downstream cell in the system.

Following items can be suppressed:

Material

Material property

Material property data

Required Arguments

Suppressed The flag to specify if the item should be suppressed or unsuppressed.

Type bool

Unlink

Unlinks a material from its underlying source. Once this occurs, the material can no longer be restored
to its original state and the material will no longer have a source.

MaterialProperty
The entity to store material property information.

A material property is the identifier for the singular information (for example, Density) that together
with other properties defines or models the behavior of the material. A property is always defined by
at least one table (tabular data), which could be singular. Some properties can contain a collection of
tabular data (for example, Isotropic Elasticity).

Properties
Behavior

The string that defines the way in which the material property behaves, e.g., Elasticity has Isotropic,
Orthotropic or Anisotropic behavior.

Type string

Read Only No

Definition

The definition of the material property. Some material properties are defined in different ways, e.g.,
Thermal Expansion can be defined as Secant Coefficient of Thermal Expansion and Instantaneous
Coefficient of Thermal Expansion.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
306 of ANSYS, Inc. and its subsidiaries and affiliates.
Description

The description of the material property.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

PropertyDataColl

The collection of tabular data that defines the material property.

Type DataReferenceSet

Read Only Yes

TypeName

The name of the material property.

Type string

Read Only No

Methods
AddTestData

Includes experimental test data for response function calculations.

Required Arguments

TestData The test data property to add.

Type DataReference

BeginBatchUpdate

Marks the start of a series of data modifications to a table of data, to improve performance.

CreatePropertyData

Include an additional property data for a material property. Some properties may have more than one
property data to describe the material property.

The preferred method of adding a material property data is to use CreateMaterialProperty.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 307
Engineering Data

Return The new material properly data that was created.

Type DataReference

Required Arguments

Name The new material property data name.

Type string

Optional Arguments

Behavior A string to identify how the new material property data will behave.

The behavior of some material properties can be specified in different ways, e.g.,
Elasticity can be specified as Isotropic, Orthotropic or Anisotropic.

Type string

Definition A string to identify how the new material property data will be defined.

Some material properties are defined in different ways, e.g., Thermal Expansion can be
defined as Secant Coefficient of Thermal Expansion and Instantaneous Coefficient of
Thermal Expansion.

Type string

Qualifiers The optional dictionary of a qualifier name and it's corresponding value.

Type Dictionary<string, string>

Example
The following example creates the material property data Orthotropic Secant Coefficient of Thermal Ex-
pansion on the material property Coefficient of Thermal Expansion. This example assumes the material
Structural Steel has been obtained from the General Materials library.

Get the material property we are going to create a new material property data on.

thermExpansionMatProp = structuralSteel.GetMaterialProperty(Name="Coefficient of Thermal Expansion")

Create the new material property data.

orthoSecantThermExpansionMatPropData = thermExpansionMatProp.CreatePropertyData(
Name="Coefficient of Thermal Expansion",
Definition="Secant",
Behavior="Orthotropic")

Delete

Deletes the material property.

Optional Arguments

Behavior The optional string to specify the material property behavior.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
308 of ANSYS, Inc. and its subsidiaries and affiliates.
 Behavior of some material properties can be specified in different ways e.g. Elasticity
can be specified as Isotropic, Orthotropic or Anisotropic.

Type string

Definition The optional string to specify the material property definition.

Some material properties are defined in different ways e.g. Thermal Expansion can be
defined as Secant Coefficient of Thermal Expansion and Instantaneous Coefficient of
Thermal Expansion.

Type string

DeleteData

Delete a row from a tabular data sheet.

Required Arguments

Index Index of the row to delete.

Type int

Optional Arguments

SheetName Name of the sheet to access.

Type string

SheetQualifiers SheetQualifiers is used to pass in the qualifiers to select between multiple sheets witht
the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

Example
The following example illustrates the deletion of a row from a tabular data sheet.

#
# Create a new Engineering Data System and access Structural Steel
#
template1 = GetTemplate(TemplateName="EngData")
system1 = template1.CreateSystem()
engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
#
# Delete the first row in the Density property
#
matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.DeleteTabularDataRow(Index = 0)
#
# Delete the first row in the Coefficient of Thermal Expansion property with optional SheeetNamea nd SheetQ
#
matlProp2 = matl1.GetProperty(Name="Coefficient of Thermal Expansion")
matlProp2.DeleteTabularDataRow(
SheetName="Coefficient of Thermal Expansion",
SheetQualifiers={"Definition Method": "Secant", "Behavior": "Isotropic"},
Index = 0)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 309
Engineering Data

EndBatchUpdate

Marks the completion of a series of data modifications.

GetChartData

Returns a generated graph data for the specified source data.

Valid source data are:

Material Property
Material Property Data

Return The graph data for the specified source data.

Type DataReference

GetData

Returns the tabular data associated with the data entity.

Return The returned data in scalar, list, or dictionary format.

Type Object

Optional Arguments

AsDictionary If set to true, the data will be returned as a dictionary where the keys are variable names
and the values are the data for each variable. If set to false, the data will be returned
in scalar or list format without the variable names.

Type bool

Default Value False

ColumnMajor If set to true, the data will be returned in column-major order. If set to false, the data
will be returned in row-major order.

Type bool

Default Value True

EndIndex The end index for requesting a subset of the data (zero-based).

Type int

Default Value -2147483647

SheetName Specifies the sheet name when the data contains multiple sheets.

Type string

SheetQualifiers Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.

Type Dictionary<string, string>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
310 of ANSYS, Inc. and its subsidiaries and affiliates.
StartIndex The start index for requesting a subset of the data (zero-based).

Type int

Default Value 0

Variables Names of the variables for which data is requested (string or list of strings).

Type Object

Example
In this example, all data is requested for the given tabular data entity.

tabData1.GetData()

In this example, all data is requested in row-major order.

tabData1.GetData(ColumnMajor=False)

In this example, all data is requested in dictionary format.

tabData1.GetData(AsDictionary=True)

In this example, data for variables Density and Temperature is requested in dictionary format.

tabData1.GetData(Variables=["Density", "Temperature"], AsDictionary=True)

GetPropertyData

Returns a property data of the specified material property.

The property data returned is based on specified optional parameters "Definition" and "Behavior".

Return The material property data that matches specified type name, definition and behavior.

Type DataReference

Required Arguments

Name The material property data type name.

Type string

Optional Arguments

Behavior The optional string to specify the material property data behavior.

Behavior of some material properties can be specified in different ways, e.g., Elasticity
can be specified as Isotropic, Orthotropic or Anisotropic.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 311
Engineering Data

Definition The optional string to specify the material property data definition.

Some material properties are defined in different ways, e.g., Thermal Expansion can be
defined as Secant Coefficient of Thermal Expansion and Instantaneous Coefficient of
Thermal Expansion.

Type string

Qualifiers The optional dictionary of a qualifier name and it's corresponding value.

Type Dictionary<string, string>

Example
The following example creates new Engineering Data system and queries Coefficient of Thermal Expansion
property data of the default material Structural Steel.

ENGDTemplate = GetTemplate(TemplateName="EngData")
ENGDSystem = ENGDTemplate.CreateSystem(Position="Default")

ENGDContainer = ENGDSystem.GetContainer(ComponentName="Engineering Data")

StructSteel = ENGDContainer.GetMaterial(Name="Structural Steel")

#Get material property

CTEProperty = StructSteel.GetProperty(Name="Coefficient of Thermal Expansion")
# Get material property data
CTEPropData = CTEProperty.GetPropertyData(
Name="Coefficient of Thermal Expansion",
Definition="Secant",
Behavior="Isotropic")
RefTempPropData = CTEProperty.GetPropertyData(
Name="Reference Temperature",
Definition="Secant",
Behavior="Isotropic")

IsSuppressed

Checks if an entity is suppressed.

Valid entities are:

Material
Material Property
Material Property Data

Return Returns true if the entity is suppressed, false otherwise.

Type bool

IsValid

Validates a material property and provides a message in case of invalid data.

Return The flag that indicates if the material property is valid.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
312 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Material The parent material of the property.

Type DataReference

Optional Arguments

Message The validation failure message.

Type Output<string>

RemoveTestData

Excludes experimental test data for response function calculations.

Required Arguments

TestData The test data property to add.

Type DataReference

SetData

Set tabular data associated with the data entity.

Optional Arguments

Data Sets the data using a dictionary form. The keys are the variable names and the values
are the data. The use of this argument is mutually exclusive with "Values" and "Vari-
ables".

Type Dictionary<string, List<Object>>

Index Specifies the starting location used to set the data (zero-based). A value of -1 indicates
that the data should be appended to the existing data.

Type int

Default Value 0

SheetName Specifies the sheet name when the data contains multiple sheets.

Type string

SheetQualifiers Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.

Type Dictionary<string, string>

Values List of data values set in conjunction with the "Variables" parameter. This parameter
and the "Data" parameter are mutually exclusive.

Type List<List<Object>>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 313
Engineering Data

Variables Names of the variables for which data is being set. This parameter and and the "Data"
parameter are mutually exclusive.

Type List<string>

Example

#
# Create a new Engineering Data System and access Structural Steel
#
template1 = GetTemplate(TemplateName="EngData")
system1 = template1.CreateSystem()
engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
#
# Change the value of a simple single-valued property
#
matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.SetData(
Variables="Density",
Values="8500 [kg m^-3]")
#
# Set Temperature-dependent data for Elasticity based
# on lists of variables and values.
matlProp2 = matl1.GetProperty(Name="Elasticity")
temperature = ["400 [K]", "600 [K]", "800 [K]"]
E = ["2e5 [MPa]", "1.9e5 [MPa]", "1.6e5 [MPa]"]
matlProp2.SetData(
Variables = ["Temperature","Young's Modulus"],
Values = [temperature, E])
#
# Change the Temperature for the second table entry.
#
matlProp2.SetData(
Index = 1,
Variables = "Temperature",
Values = "625 [K]")
#
# Set a list for Poisson's Ratio starting at the second table entry.
#
matlProp2.SetData(
Index = 1,
Variables = "Poisson's Ratio",
Values = [0.3, 0.3])
#
# Set Temperature-dependent property data for the Coefficient of Thermal Expansion
# using a dictionary. The dictionary key is the Variable name,
# followed by the list of values for the variable.
#
matlProp3 = matl1.GetProperty(Name="Coefficient of Thermal Expansion")
newData = {"Temperature": ["200 [F]","400 [F]","600 [F]","800 [F]","1000 [F]"],
"Coefficient of Thermal Expansion" : ["6.3e-6 [F^-1]", "7.0e-6 [F^-1]",
"7.46e-6 [F^-1]", "7.8e-6 [F^-1]",
"8.04e-6 [F^-1]"]}
matlProp3.SetData(
SheetName="Coefficient of Thermal Expansion",
SheetQualifiers={"Definition Method": "Secant", "Behavior": "Isotropic"},
Data = newData)

SetQualifier

Changes the values of a specifiec qualifier in a data table.

Required Arguments

Qualifier The Qualifier to Set.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
314 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Value The new value.

Type string

Optional Arguments

SheetName The name of the tabular data sheet that contains the qualifier.

Type string

SheetQualifiers SheetQualifiers can be used to pass in the qualifiers to select between multiple
sheets witht the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

VariableName The name of the Variable that contains the qualifier to be changed.

Type string

VariableQualifiers VariableQualifiers can used to pass in the qualifiers to select between multiple
variables witht the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

Example
The following example changes the 'Derive From' setting within an Isotropic Elasticity material property
to be "Bulk Modulus and Poisson's Ratio".

matl1 = engineeringData1.GetMaterial(Name="Structural Steel")

matlProp1 = matl1.GetProperty(Name="Elasticity")
matlProp1.SetQualifier(
SheetName="Elasticity",
Qualifier="Derive from",
Value="Bulk Modulus and Poisson's Ratio")

SetSuppression

Suppresses or Unsuppresses item.

Item can be suppressed to prevent it from being sent to a downstream cell in the system.

Following items can be suppressed:

Material

Material property

Material property data

Required Arguments

Suppressed The flag to specify if the item should be suppressed or unsuppressed.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 315
Engineering Data

MaterialPropertyData
The entity to store material property (tabular) data information. The material property data is a collection
of material variable data.

Properties
Behavior

The behavior of the material variable tabular data. Some material properties can have different behavior,
e.g., Elasticity has Isotropic, Orthotropic or Anisotropic behavior.

Type string

Read Only No

Definition

The definition of the material variable tabular data. Some material properties are defined in different
ways, e.g., Thermal Expansion can be defined as Secant Coefficient of Thermal Expansion and Instant-
aneous Coefficient of Thermal Expansion.

Type string

Read Only No

DependentColl

The collection of dependent variables in the material variable tabular data, e.g., Density.

Type DataReferenceSet

Read Only Yes

Description

The description of the material variable tabular data.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IndependentColl

The collection of independent variables in the material variable tabular data, e.g., Temperature.

Type DataReferenceSet

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
316 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only Yes

PrimaryIndependent

The primary independent variable in the material variable tabular data, e.g., Temperature.

Type DataReference

Read Only Yes

RowsCount

The number of data values for a variable in the material variable tabular data.

Type int

Read Only Yes

TypeName

The name of the material variable tabular data.

Type string

Read Only No

VariableColl

The collection of variables in the material variable tabular data.

Type DataReferenceSet

Read Only Yes

Methods
BeginBatchUpdate

Marks the start of a series of data modifications to a table of data, to improve performance.

CreateCurveFitting

Creates a curve fitting for a given property data.

Return The curve fitting.

Type DataReference

Required Arguments

Definition The definition of curve fitting to create. This must be a definition that is supported by an en-
gineering data curve fitting.

i.e. 1 Parameter, 2 Parameter, 1st Order, 2nd Order

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 317
Engineering Data

Type The type of curve fitting to create. This must be a type that is supported by an engineering
data curve fitting.

i.e. Neo-Hookean, Mooney-Rivlin, Ogden, Yeoh, Polynomial

Type string

Example
The following example loads a material with experimental test data and a Neo-Hookean hyperelastic
property.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem()
engineeringData = system.GetContainer(ComponentName="Engineering Data")
neopreneRubber = engineeringData.ReadMaterial(
Name="Neoprene Rubber",
Source="Hyperelastic_Materials.xml")
neoHookeanProperty = neopreneRubber.GetProperty(Name="Neo-Hookean")
neoHookeanPropertyData = neoHookeanProperty.GetPropertyData(Name="Neo-Hookean")
curveFit = neoHookeanPropertyData.CreateCurveFitting(
Type="Neo-Hookean",
Definition="")
uniaxialProperty = neopreneRubber.GetProperty(Name="Uniaxial Test Data")
curveFit.AddTestData(TestData=uniaxialProperty)
biaxialProperty = neopreneRubber.GetProperty(Name="Biaxial Test Data")
curveFit.AddTestData(TestData=biaxialProperty)
shearProperty = neopreneRubber.GetProperty(Name="Shear Test Data")
curveFit.AddTestData(TestData=shearProperty)
volumetricProperty = neopreneRubber.GetProperty(Name="Volumetric Test Data")
curveFit.AddTestData(TestData=volumetricProperty)
curveFit.RemoveTestData(TestData=uniaxialProperty)
curveFit.AddTestData(TestData=uniaxialProperty)
curveFit.Solve()
curveFit.CopyCoefficients(Destination=neoHookeanPropertyData)
curveFit.Delete()

CreateVariable

Include an additional variable in the property data for a material property.

Return The new variable data that was created.

Type DataReference

Required Arguments

Name The new variable data name.

Type string

Optional Arguments

Qualifiers The optional dictionary of a qualifier name and it's corresponding value.

Type Dictionary<string, string>

Delete

Deletes the material property data.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
318 of ANSYS, Inc. and its subsidiaries and affiliates.
EndBatchUpdate

Marks the completion of a series of data modifications.

GetChartData

Returns a generated graph data for the specified source data.

Valid source data are:

Material Property
Material Property Data

Return The graph data for the specified source data.

Type DataReference

GetCurveFitting

Query to return the DataReference to the CurveFit used by some PropertyData.

Return CurveFit DataReference

Type DataReference

GetVariable

Returns a material variable of a given name from a material property data.

Return The requested variable.

Type DataReference

Required Arguments

Name The name of the variable.

Type string

Example
The following example creates new Engineering Data system and queries Coefficient of Thermal Expansion
property data of the default material Structural Steel.

ENGDTemplate = GetTemplate(TemplateName="EngData")
ENGDSystem = ENGDTemplate.CreateSystem(Position="Default")

ENGDContainer = ENGDSystem.GetContainer(ComponentName="Engineering Data")

StructSteel = ENGDContainer.GetMaterial(Name="Structural Steel")

# Get material
CTEProperty = StructSteel.GetProperty(Name="Coefficient of Thermal Expansion")
# Get material property data
CTEPropData = CTEProperty.GetPropertyData(
Name="Coefficient of Thermal Expansion",
Definition="Secant",
Behavior="Isotropic")
# Get material variable
CTEVariable = CTEPropData.GetVariable(

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 319
Engineering Data

Name="Coefficient of Thermal Expansion")

IsSuppressed

Checks if an entity is suppressed.

Valid entities are:

Material
Material Property
Material Property Data

Return Returns true if the entity is suppressed, false otherwise.

Type bool

IsValid

Validates a material property data and provides a message in case of invalid data.

Return The flag that indicates if the material property data is valid.

Type bool

Required Arguments

Material The parent material of the material property data.

Type DataReference

Optional Arguments

Message The validation failure message.

Type Output<string>

SetSuppression

Suppresses or Unsuppresses item.

Item can be suppressed to prevent it from being sent to a downstream cell in the system.

Following items can be suppressed:

Material

Material property

Material property data

Required Arguments

Suppressed The flag to specify if the item should be suppressed or unsuppressed.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
320 of ANSYS, Inc. and its subsidiaries and affiliates.
MaterialVariable
The entity to store material variable information.

Properties
DatumColl

The collection of the material variable data.

Type DataReferenceSet

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsDependent

The flag that indicates if the material variable is dependent, e.g., Density is temperature dependent.

Type bool

Read Only No

LowerBoundUnit

The unit of the lower bound data value in the material variable data.

Type string

Read Only No

LowerBoundValue

The lower bound data value in the material variable data.

Type double

Read Only No

MaxValue

The maximum value limit of the material variable data.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 321
Engineering Data

MinValue

The minimum value limit of the material variable data.

Type double

Read Only No

Offset

The offset value of the material variable data.

Type Quantity

Read Only No

Scale

The scale factor of the material variable data.

Type double

Read Only No

TypeName

The name of the material variable.

Type string

Read Only No

UniqueData

The collection of unique data values in the material variable data.

Type DataReferenceSet

Read Only No

UpperBoundUnit

The unit of the upper bound data value in the material variable data.

Type string

Read Only No

UpperBoundValue

The upper bound data value in the material variable data.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
322 of ANSYS, Inc. and its subsidiaries and affiliates.
Methods
Delete

Deletes an additional variable in the property data from a material property.

IsValid

Validates a material variable data and provides a message in case of invalid data.

Return The flag that indicates if the material variable is valid.

Type bool

Required Arguments

Material The parent material of the variable.

Type DataReference

MaterialPropertyData The parent material property data of the variable.

Type DataReference

Optional Arguments

Message The validation failure message.

Type Output<string>

Example
template = GetTemplate(TemplateName="EngData") system = template.CreateSystem(Position="Default")
container = system.GetContainer(ComponentName="Engineering Data") structSteel = container.GetMater-
ial(Name="Structural Steel") CTEProp = structSteel.GetProperty(Name="Coefficient of Thermal Expansion")
CTEPropData = CTEProperty.GetPropertyData( Name="Coefficient of Thermal Expansion", Definition="Sec-
ant", Behavior="Isotropic") CTEVariable = CTEPropData.GetVariable( Name="Coefficient of Thermal Expan-
sion") valid = EngData.ValidateMaterialVariable(MaterialVariable=CTEVariable, Material=structSteel, Mater-
ialPropertyData=CTEPropdata)

Engineering Data Curve Fit

The container used by Engineering Data to maintain data for curve fitting operations.

Data Entities
CurveFit
The entity to store curve fitting information.

Properties
CurveFitData

The coefficients of material model that approximates the experimental test data.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 323
Engineering Data

Type DataReference

Read Only No

DependentPropertyColl

The collection of experimental test data, e.g., Uniaxial Test data (Engineering Strain Vs Engineering
Stress).

Type DataReferenceSet

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

UnitSystemWhenSolved

The unit system of the coefficients of material model.

Type string

Read Only No

Methods
AddTestData

Adds test data from a given curve fitting.

Required Arguments

TestData The test data property to add.

Type DataReference

Example
The following example loads a material with experimental test data and a Neo-Hookean hyperelastic
property.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem()
engineeringData = system.GetContainer(ComponentName="Engineering Data")
neopreneRubber = engineeringData.ReadMaterial(
Name="Neoprene Rubber",
Source="Hyperelastic_Materials.xml")
neoHookeanProperty = neopreneRubber.GetProperty(Name="Neo-Hookean")
neoHookeanPropertyData = neoHookeanProperty.GetPropertyData(Name="Neo-Hookean")
curveFit = neoHookeanPropertyData.CreateCurveFitting(
Type="Neo-Hookean",
Definition="")
uniaxialProperty = neopreneRubber.GetProperty(Name="Uniaxial Test Data")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
324 of ANSYS, Inc. and its subsidiaries and affiliates.
 curveFit.AddTestData(TestData=uniaxialProperty)
biaxialProperty = neopreneRubber.GetProperty(Name="Biaxial Test Data")
curveFit.AddTestData(TestData=biaxialProperty)
shearProperty = neopreneRubber.GetProperty(Name="Shear Test Data")
curveFit.AddTestData(TestData=shearProperty)
volumetricProperty = neopreneRubber.GetProperty(Name="Volumetric Test Data")
curveFit.AddTestData(TestData=volumetricProperty)
curveFit.RemoveTestData(TestData=uniaxialProperty)
curveFit.AddTestData(TestData=uniaxialProperty)
curveFit.Solve()
curveFit.CopyCoefficients(Destination=neoHookeanPropertyData)
curveFit.Delete()

CopyCoefficients

Copies the fitted coefficients from the curve fitting to the property data provided.

Required Arguments

Destination The property data that will receive the coefficients.

Type DataReference

Example
The following example loads a material with experimental test data and a Neo-Hookean hyperelastic
property.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem()
engineeringData = system.GetContainer(ComponentName="Engineering Data")
neopreneRubber = engineeringData.ReadMaterial(
Name="Neoprene Rubber",
Source="Hyperelastic_Materials.xml")
neoHookeanProperty = neopreneRubber.GetProperty(Name="Neo-Hookean")
neoHookeanPropertyData = neoHookeanProperty.GetPropertyData(Name="Neo-Hookean")
curveFit = neoHookeanPropertyData.CreateCurveFitting(
Type="Neo-Hookean",
Definition="")
uniaxialProperty = neopreneRubber.GetProperty(Name="Uniaxial Test Data")
curveFit.AddTestData(TestData=uniaxialProperty)
biaxialProperty = neopreneRubber.GetProperty(Name="Biaxial Test Data")
curveFit.AddTestData(TestData=biaxialProperty)
shearProperty = neopreneRubber.GetProperty(Name="Shear Test Data")
curveFit.AddTestData(TestData=shearProperty)
volumetricProperty = neopreneRubber.GetProperty(Name="Volumetric Test Data")
curveFit.AddTestData(TestData=volumetricProperty)
curveFit.RemoveTestData(TestData=uniaxialProperty)
curveFit.AddTestData(TestData=uniaxialProperty)
curveFit.Solve()
curveFit.CopyCoefficients(Destination=neoHookeanPropertyData)
curveFit.Delete()

Delete

Deletes a curve fitting.

Example
The following example loads a material with experimental test data and a Neo-Hookean hyperelastic
property.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 325
Engineering Data

engineeringData = system.GetContainer(ComponentName="Engineering Data")

neopreneRubber = engineeringData.ReadMaterial(
Name="Neoprene Rubber",
Source="Hyperelastic_Materials.xml")
neoHookeanProperty = neopreneRubber.GetProperty(Name="Neo-Hookean")
neoHookeanPropertyData = neoHookeanProperty.GetPropertyData(Name="Neo-Hookean")
curveFit = neoHookeanPropertyData.CreateCurveFitting(
Type="Neo-Hookean",
Definition="")
uniaxialProperty = neopreneRubber.GetProperty(Name="Uniaxial Test Data")
curveFit.AddTestData(TestData=uniaxialProperty)
biaxialProperty = neopreneRubber.GetProperty(Name="Biaxial Test Data")
curveFit.AddTestData(TestData=biaxialProperty)
shearProperty = neopreneRubber.GetProperty(Name="Shear Test Data")
curveFit.AddTestData(TestData=shearProperty)
volumetricProperty = neopreneRubber.GetProperty(Name="Volumetric Test Data")
curveFit.AddTestData(TestData=volumetricProperty)
curveFit.RemoveTestData(TestData=uniaxialProperty)
curveFit.AddTestData(TestData=uniaxialProperty)
curveFit.Solve()
curveFit.CopyCoefficients(Destination=neoHookeanPropertyData)
curveFit.Delete()

GetChartData

Returns a generated graph data for the specified source data.

Valid source data are:

Material Property
Material Property Data

Return The graph data for the specified source data.

Type DataReference

RemoveTestData

Removes test data from a given curve fitting.

Required Arguments

TestData The test data property to add.

Type DataReference

Example
The following example loads a material with experimental test data and a Neo-Hookean hyperelastic
property.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem()
engineeringData = system.GetContainer(ComponentName="Engineering Data")
neopreneRubber = engineeringData.ReadMaterial(
Name="Neoprene Rubber",
Source="Hyperelastic_Materials.xml")
neoHookeanProperty = neopreneRubber.GetProperty(Name="Neo-Hookean")
neoHookeanPropertyData = neoHookeanProperty.GetPropertyData(Name="Neo-Hookean")
curveFit = neoHookeanPropertyData.CreateCurveFitting(
Type="Neo-Hookean",
Definition="")
uniaxialProperty = neopreneRubber.GetProperty(Name="Uniaxial Test Data")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
326 of ANSYS, Inc. and its subsidiaries and affiliates.
 curveFit.AddTestData(TestData=uniaxialProperty)
biaxialProperty = neopreneRubber.GetProperty(Name="Biaxial Test Data")
curveFit.AddTestData(TestData=biaxialProperty)
shearProperty = neopreneRubber.GetProperty(Name="Shear Test Data")
curveFit.AddTestData(TestData=shearProperty)
volumetricProperty = neopreneRubber.GetProperty(Name="Volumetric Test Data")
curveFit.AddTestData(TestData=volumetricProperty)
curveFit.RemoveTestData(TestData=uniaxialProperty)
curveFit.AddTestData(TestData=uniaxialProperty)
curveFit.Solve()
curveFit.CopyCoefficients(Destination=neoHookeanPropertyData)
curveFit.Delete()

Solve

The curve fitting module will solve for the coefficients which most nearly approximate the experimental
test data.

Engineering Data Favorite Items

The container used by Engineering Data to maintain favorite items.

Methods
GetMaterial
Returns a material of a given name from a container.

The name matching is case insensitive. If a material is not found an exception is thrown.

Return The material that matches the specified name.

Type DataReference

Required Arguments

Name The name of the material. This argument is case insensitive.

Type string

Example
The following example creates a new Engineering Data system and queries the default material, Structural
Steel.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem(Position="Default")
container = system.GetContainer(ComponentName="Engineering Data")
structuralSteel = container.GetMaterial(Name="Structural Steel")

GetMaterials
Returns the list of materials in a container. If no materials are in the container, the list is empty.

Return A DataReferenceSet of the materials in the container.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 327
Engineering Data

Type DataReferenceSet

Load
Populates the favorite items container with the user's favorite items.

Returns the favorite items container.

Return The favorite items container.

Type DataContainerReference

Example
The following example creates a new Engineering Data system and queries the default material, Structural
Steel.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem(Position="Default")
favoritesContainer = EngData.LoadFavoriteItems()
structuralSteel = favoritesContainer.GetMaterial(Name="Structural Steel")

Data Entities
Material
The entity to store material information.

Properties
Description

The description of the material.

Type string

Read Only No

DisplayName

The display name of the material.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
328 of ANSYS, Inc. and its subsidiaries and affiliates.
Source

The path of the material's source file ("*.engd" or "*.xml").

Type string

Read Only Yes

Methods
AddToFavorites

Adds an item to the Favorites item list.

CreateProperty

Includes a physical quantity or the constitutive relation for the physical response of a material. A property
can be visualized as one or more tables of data made up of one or more dependent and independent
variables.

The material property is created based on the specified optional parameters "Definition" and "Behavior".

Return Created material properly.

Type DataReference

Required Arguments

Name The new material property name.

Type string

Optional Arguments

Behavior The optional string to identify the way in which a new material property will behave.

Behavior of some material properties can be specified in different ways, e.g., Elasticity
can be specified as Isotropic, Orthotropic or Anisotropic.

Type string

Definition The optional string to identify the way in which new material property will be defined.

Some material properties are defined in different ways, e.g., Thermal Expansion can be
defined as Secant Coefficient of Thermal Expansion and Instantaneous Coefficient of
Thermal Expansion.

Type string

Qualifiers The optional dictionary of a qualifier name and it's corresponding value.

Type Dictionary<string, string>

Example
The following example creates a new Engineering Data system and adds Coefficient of Thermal Expansion
and Elasticity material properties to the default material Structural Steel.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 329
Engineering Data

Coefficient of Thermal Expansion is created using Secant definition and Orthotropic behavior.
Elasticity is created using Orthotropic behavior.

ENGDTemplate = GetTemplate(TemplateName="EngData")
ENGDSystem = ENGDTemplate.CreateSystem(Position="Default")

ENGDContainer = ENGDSystem.GetContainer(ComponentName="Engineering Data")

StructSteel = ENGDContainer.GetMaterial(Name="Structural Steel")

# Create material properties

CTEProperty = StructSteel.CreateProperty(
Name="Coefficient of Thermal Expansion",
Definition="Secant",
Behavior="Orthotropic")
OrthoElasProperty = StructSteel.CreateProperty(
Name="Elasticity",
Behavior="Orthotropic")

Delete

Deletes the material.

Duplicate

Duplicates the data in this material and returns a new material. The name of the new material will be
appended with a numerical value to make it unique.

Return The material data reference of the duplicated material.

Type DataReference

Required Arguments

TargetContainer The duplicated material will be added to this container.

Type DataContainerReference

GetProperty

Returns a material property of a given name from the specified material.

Return The material property that matches the specified name.

Type DataReference

Required Arguments

Name The name of the material property.

Type string

Example
The following example creates new Engineering Data system and queries Coefficient of Thermal Expansion
property of the default material Structural Steel.

ENGDTemplate = GetTemplate(TemplateName="EngData")
ENGDSystem = ENGDTemplate.CreateSystem(Position="Default")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
330 of ANSYS, Inc. and its subsidiaries and affiliates.
 ENGDContainer = ENGDSystem.GetContainer(ComponentName="Engineering Data")
StructSteel = ENGDContainer.GetMaterial(Name="Structural Steel")

# Get material property

CTEProperty = StructSteel.GetProperty(Name="Coefficient of Thermal Expansion")

IsSuppressed

Checks if an entity is suppressed.

Valid entities are:

Material
Material Property
Material Property Data

Return Returns true if the entity is suppressed, false otherwise.

Type bool

IsValid

Validates a material data and provides a message in case of invalid data.

Return The flag that indicates if the material is valid.

Type bool

Optional Arguments

Message The validation failure message.

Type Output<string>

Refresh

This will repopulate the contents of a material with data from a given source. The NameInSource
property of a Material will be used to find a match in the source to pull data from. In the event that
NameInSource is not set, the DisplayName property will be used instead.

Note: This operation will cause destruction of any data currently in the material.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem(Position="Default")
container = system.GetContainer(ComponentName="Engineering Data")
structSteel = container.GetMaterial(Name="Structural Steel")
density = structSteel.GetProperty(Name="Density")
density.Delete()
structSteel.UpdateMaterial(Source="General_Materials.xml")
restoredDensity = structSteel.GetProperty(Name="Density")
restoredDensity.SetData(SheetName="", Index=0, Variables=["Density"], Values=[["8000 [kg m^-3]"]])

Required Arguments

Source The path of the source file.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 331
Engineering Data

RemoveFromFavorites

Removes an item from the Favorite items list.

Optional Arguments

Format The format of the file that contains the item.

Type string

Material A DataReference to the Material to delete.

Type DataReference

Name The name of the item to delete.

Type string

Source The location of the file that contains the item on disk.

Type string

Type The type of the object to delete. This is either a Material or a Mixture.

Type EngineeringDataType

Example
The following example gets the list of favorites from Engineering Data. It then selects and deletes the "Gray
Cast Iron" material from the list.

favorites = EngData.LoadFavoriteItems()
matl = favorites.GetMaterial(Name="Gray Cast Iron")
EngData.DeleteFromFavorites(
Material=matl,
Type="Material")

SetAsDefaultFluidForModel

This will specify the material to use (or not use) for parts in the model which are marked as a fluid.

If the material is in the Engineering Data component it will set or unset the material to be used in the
model component of the system(s) that contain this Engineering Data component.

If the material is contained in Favorites it will set or unset the material to use as the default on fluids
in the Engineering Data component when a new system is added to the project.

The material is set as the default in Favorites. It will automatically be added to the list of project defaults.

Optional Arguments

Default This Boolean is used to set or unset the material as the default.

Type bool

Default Value True

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
332 of ANSYS, Inc. and its subsidiaries and affiliates.
SetAsDefaultSolidForModel

This will specify the material to use (or not use) for parts in the model which are marked as a solid.

If the material is in the Engineering Data component it will set or unset the material to be used in the
model component of the system(s) that contain this Engineering Data component.

If the material is contained in Favorites it will set or unset the material to use as the default on solids
in the Engineering Data component when a new system is added to the project.

The material is set as the default in Favorites. It will automatically be added to the list of project defaults.

Optional Arguments

Default This Boolean is used to set or unset the material as the default.

Type bool

Default Value True

SetSuppression

Suppresses or Unsuppresses item.

Item can be suppressed to prevent it from being sent to a downstream cell in the system.

Following items can be suppressed:

Material

Material property

Material property data

Required Arguments

Suppressed The flag to specify if the item should be suppressed or unsuppressed.

Type bool

Unlink

Unlinks a material from its underlying source. Once this occurs, the material can no longer be restored
to its original state and the material will no longer have a source.

MaterialProperty
The entity to store material property information.

A material property is the identifier for the singular information (for example, Density) that together
with other properties defines or models the behavior of the material. A property is always defined by
at least one table (tabular data), which could be singular. Some properties can contain a collection of
tabular data (for example, Isotropic Elasticity).

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 333
Engineering Data

Properties
Behavior

The string that defines the way in which the material property behaves, e.g., Elasticity has Isotropic,
Orthotropic or Anisotropic behavior.

Type string

Read Only No

Definition

The definition of the material property. Some material properties are defined in different ways, e.g.,
Thermal Expansion can be defined as Secant Coefficient of Thermal Expansion and Instantaneous
Coefficient of Thermal Expansion.

Type string

Read Only No

Description

The description of the material property.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

PropertyDataColl

The collection of tabular data that defines the material property.

Type DataReferenceSet

Read Only Yes

TypeName

The name of the material property.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
334 of ANSYS, Inc. and its subsidiaries and affiliates.
Methods
AddTestData

Includes experimental test data for response function calculations.

Required Arguments

TestData The test data property to add.

Type DataReference

BeginBatchUpdate

Marks the start of a series of data modifications to a table of data, to improve performance.

CreatePropertyData

Include an additional property data for a material property. Some properties may have more than one
property data to describe the material property.

The preferred method of adding a material property data is to use CreateMaterialProperty.

Return The new material properly data that was created.

Type DataReference

Required Arguments

Name The new material property data name.

Type string

Optional Arguments

Behavior A string to identify how the new material property data will behave.

The behavior of some material properties can be specified in different ways, e.g.,
Elasticity can be specified as Isotropic, Orthotropic or Anisotropic.

Type string

Definition A string to identify how the new material property data will be defined.

Some material properties are defined in different ways, e.g., Thermal Expansion can be
defined as Secant Coefficient of Thermal Expansion and Instantaneous Coefficient of
Thermal Expansion.

Type string

Qualifiers The optional dictionary of a qualifier name and it's corresponding value.

Type Dictionary<string, string>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 335
Engineering Data

Example
The following example creates the material property data Orthotropic Secant Coefficient of Thermal Ex-
pansion on the material property Coefficient of Thermal Expansion. This example assumes the material
Structural Steel has been obtained from the General Materials library.

Get the material property we are going to create a new material property data on.

thermExpansionMatProp = structuralSteel.GetMaterialProperty(Name="Coefficient of Thermal Expansion")

Create the new material property data.

orthoSecantThermExpansionMatPropData = thermExpansionMatProp.CreatePropertyData(
Name="Coefficient of Thermal Expansion",
Definition="Secant",
Behavior="Orthotropic")

Delete

Deletes the material property.

Optional Arguments

Behavior The optional string to specify the material property behavior.

Behavior of some material properties can be specified in different ways e.g. Elasticity
can be specified as Isotropic, Orthotropic or Anisotropic.

Type string

Definition The optional string to specify the material property definition.

Some material properties are defined in different ways e.g. Thermal Expansion can be
defined as Secant Coefficient of Thermal Expansion and Instantaneous Coefficient of
Thermal Expansion.

Type string

DeleteData

Delete a row from a tabular data sheet.

Required Arguments

Index Index of the row to delete.

Type int

Optional Arguments

SheetName Name of the sheet to access.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
336 of ANSYS, Inc. and its subsidiaries and affiliates.
SheetQualifiers SheetQualifiers is used to pass in the qualifiers to select between multiple sheets witht
the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

Example
The following example illustrates the deletion of a row from a tabular data sheet.

#
# Create a new Engineering Data System and access Structural Steel
#
template1 = GetTemplate(TemplateName="EngData")
system1 = template1.CreateSystem()
engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
#
# Delete the first row in the Density property
#
matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.DeleteTabularDataRow(Index = 0)
#
# Delete the first row in the Coefficient of Thermal Expansion property with optional SheeetNamea nd SheetQ
#
matlProp2 = matl1.GetProperty(Name="Coefficient of Thermal Expansion")
matlProp2.DeleteTabularDataRow(
SheetName="Coefficient of Thermal Expansion",
SheetQualifiers={"Definition Method": "Secant", "Behavior": "Isotropic"},
Index = 0)

EndBatchUpdate

Marks the completion of a series of data modifications.

GetChartData

Returns a generated graph data for the specified source data.

Valid source data are:

Material Property
Material Property Data

Return The graph data for the specified source data.

Type DataReference

GetData

Returns the tabular data associated with the data entity.

Return The returned data in scalar, list, or dictionary format.

Type Object

Optional Arguments

AsDictionary If set to true, the data will be returned as a dictionary where the keys are variable names
and the values are the data for each variable. If set to false, the data will be returned
in scalar or list format without the variable names.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 337
Engineering Data

Type bool

Default Value False

ColumnMajor If set to true, the data will be returned in column-major order. If set to false, the data
will be returned in row-major order.

Type bool

Default Value True

EndIndex The end index for requesting a subset of the data (zero-based).

Type int

Default Value -2147483647

SheetName Specifies the sheet name when the data contains multiple sheets.

Type string

SheetQualifiers Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.

Type Dictionary<string, string>

StartIndex The start index for requesting a subset of the data (zero-based).

Type int

Default Value 0

Variables Names of the variables for which data is requested (string or list of strings).

Type Object

Example
In this example, all data is requested for the given tabular data entity.

tabData1.GetData()

In this example, all data is requested in row-major order.

tabData1.GetData(ColumnMajor=False)

In this example, all data is requested in dictionary format.

tabData1.GetData(AsDictionary=True)

In this example, data for variables Density and Temperature is requested in dictionary format.

tabData1.GetData(Variables=["Density", "Temperature"], AsDictionary=True)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
338 of ANSYS, Inc. and its subsidiaries and affiliates.
GetPropertyData

Returns a property data of the specified material property.

The property data returned is based on specified optional parameters "Definition" and "Behavior".

Return The material property data that matches specified type name, definition and behavior.

Type DataReference

Required Arguments

Name The material property data type name.

Type string

Optional Arguments

Behavior The optional string to specify the material property data behavior.

Behavior of some material properties can be specified in different ways, e.g., Elasticity
can be specified as Isotropic, Orthotropic or Anisotropic.

Type string

Definition The optional string to specify the material property data definition.

Some material properties are defined in different ways, e.g., Thermal Expansion can be
defined as Secant Coefficient of Thermal Expansion and Instantaneous Coefficient of
Thermal Expansion.

Type string

Qualifiers The optional dictionary of a qualifier name and it's corresponding value.

Type Dictionary<string, string>

Example
The following example creates new Engineering Data system and queries Coefficient of Thermal Expansion
property data of the default material Structural Steel.

ENGDTemplate = GetTemplate(TemplateName="EngData")
ENGDSystem = ENGDTemplate.CreateSystem(Position="Default")

ENGDContainer = ENGDSystem.GetContainer(ComponentName="Engineering Data")

StructSteel = ENGDContainer.GetMaterial(Name="Structural Steel")

#Get material property

CTEProperty = StructSteel.GetProperty(Name="Coefficient of Thermal Expansion")
# Get material property data
CTEPropData = CTEProperty.GetPropertyData(
Name="Coefficient of Thermal Expansion",
Definition="Secant",
Behavior="Isotropic")
RefTempPropData = CTEProperty.GetPropertyData(
Name="Reference Temperature",
Definition="Secant",
Behavior="Isotropic")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 339
Engineering Data

IsSuppressed

Checks if an entity is suppressed.

Valid entities are:

Material
Material Property
Material Property Data

Return Returns true if the entity is suppressed, false otherwise.

Type bool

IsValid

Validates a material property and provides a message in case of invalid data.

Return The flag that indicates if the material property is valid.

Type bool

Required Arguments

Material The parent material of the property.

Type DataReference

Optional Arguments

Message The validation failure message.

Type Output<string>

RemoveTestData

Excludes experimental test data for response function calculations.

Required Arguments

TestData The test data property to add.

Type DataReference

SetData

Set tabular data associated with the data entity.

Optional Arguments

Data Sets the data using a dictionary form. The keys are the variable names and the values
are the data. The use of this argument is mutually exclusive with "Values" and "Vari-
ables".

Type Dictionary<string, List<Object>>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
340 of ANSYS, Inc. and its subsidiaries and affiliates.
Index Specifies the starting location used to set the data (zero-based). A value of -1 indicates
that the data should be appended to the existing data.

Type int

Default Value 0

SheetName Specifies the sheet name when the data contains multiple sheets.

Type string

SheetQualifiers Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.

Type Dictionary<string, string>

Values List of data values set in conjunction with the "Variables" parameter. This parameter
and the "Data" parameter are mutually exclusive.

Type List<List<Object>>

Variables Names of the variables for which data is being set. This parameter and and the "Data"
parameter are mutually exclusive.

Type List<string>

Example

#
# Create a new Engineering Data System and access Structural Steel
#
template1 = GetTemplate(TemplateName="EngData")
system1 = template1.CreateSystem()
engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
#
# Change the value of a simple single-valued property
#
matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.SetData(
Variables="Density",
Values="8500 [kg m^-3]")
#
# Set Temperature-dependent data for Elasticity based
# on lists of variables and values.
matlProp2 = matl1.GetProperty(Name="Elasticity")
temperature = ["400 [K]", "600 [K]", "800 [K]"]
E = ["2e5 [MPa]", "1.9e5 [MPa]", "1.6e5 [MPa]"]
matlProp2.SetData(
Variables = ["Temperature","Young's Modulus"],
Values = [temperature, E])
#
# Change the Temperature for the second table entry.
#
matlProp2.SetData(
Index = 1,
Variables = "Temperature",
Values = "625 [K]")
#
# Set a list for Poisson's Ratio starting at the second table entry.
#
matlProp2.SetData(
Index = 1,
Variables = "Poisson's Ratio",

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 341
Engineering Data

Values = [0.3, 0.3])

#
# Set Temperature-dependent property data for the Coefficient of Thermal Expansion
# using a dictionary. The dictionary key is the Variable name,
# followed by the list of values for the variable.
#
matlProp3 = matl1.GetProperty(Name="Coefficient of Thermal Expansion")
newData = {"Temperature": ["200 [F]","400 [F]","600 [F]","800 [F]","1000 [F]"],
"Coefficient of Thermal Expansion" : ["6.3e-6 [F^-1]", "7.0e-6 [F^-1]",
"7.46e-6 [F^-1]", "7.8e-6 [F^-1]",
"8.04e-6 [F^-1]"]}
matlProp3.SetData(
SheetName="Coefficient of Thermal Expansion",
SheetQualifiers={"Definition Method": "Secant", "Behavior": "Isotropic"},
Data = newData)

SetQualifier

Changes the values of a specifiec qualifier in a data table.

Required Arguments

Qualifier The Qualifier to Set.

Type string

Value The new value.

Type string

Optional Arguments

SheetName The name of the tabular data sheet that contains the qualifier.

Type string

SheetQualifiers SheetQualifiers can be used to pass in the qualifiers to select between multiple
sheets witht the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

VariableName The name of the Variable that contains the qualifier to be changed.

Type string

VariableQualifiers VariableQualifiers can used to pass in the qualifiers to select between multiple
variables witht the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

Example
The following example changes the 'Derive From' setting within an Isotropic Elasticity material property
to be "Bulk Modulus and Poisson's Ratio".

matl1 = engineeringData1.GetMaterial(Name="Structural Steel")

matlProp1 = matl1.GetProperty(Name="Elasticity")
matlProp1.SetQualifier(
SheetName="Elasticity",
Qualifier="Derive from",

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
342 of ANSYS, Inc. and its subsidiaries and affiliates.
 Value="Bulk Modulus and Poisson's Ratio")

SetSuppression

Suppresses or Unsuppresses item.

Item can be suppressed to prevent it from being sent to a downstream cell in the system.

Following items can be suppressed:

Material

Material property

Material property data

Required Arguments

Suppressed The flag to specify if the item should be suppressed or unsuppressed.

Type bool

MaterialPropertyData
The entity to store material property (tabular) data information. The material property data is a collection
of material variable data.

Properties
Behavior

The behavior of the material variable tabular data. Some material properties can have different behavior,
e.g., Elasticity has Isotropic, Orthotropic or Anisotropic behavior.

Type string

Read Only No

Definition

The definition of the material variable tabular data. Some material properties are defined in different
ways, e.g., Thermal Expansion can be defined as Secant Coefficient of Thermal Expansion and Instant-
aneous Coefficient of Thermal Expansion.

Type string

Read Only No

DependentColl

The collection of dependent variables in the material variable tabular data, e.g., Density.

Type DataReferenceSet

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 343
Engineering Data

Description

The description of the material variable tabular data.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IndependentColl

The collection of independent variables in the material variable tabular data, e.g., Temperature.

Type DataReferenceSet

Read Only Yes

PrimaryIndependent

The primary independent variable in the material variable tabular data, e.g., Temperature.

Type DataReference

Read Only Yes

RowsCount

The number of data values for a variable in the material variable tabular data.

Type int

Read Only Yes

TypeName

The name of the material variable tabular data.

Type string

Read Only No

VariableColl

The collection of variables in the material variable tabular data.

Type DataReferenceSet

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
344 of ANSYS, Inc. and its subsidiaries and affiliates.
Methods
BeginBatchUpdate

Marks the start of a series of data modifications to a table of data, to improve performance.

CreateCurveFitting

Creates a curve fitting for a given property data.

Return The curve fitting.

Type DataReference

Required Arguments

Definition The definition of curve fitting to create. This must be a definition that is supported by an en-
gineering data curve fitting.

i.e. 1 Parameter, 2 Parameter, 1st Order, 2nd Order

Type string

Type The type of curve fitting to create. This must be a type that is supported by an engineering
data curve fitting.

i.e. Neo-Hookean, Mooney-Rivlin, Ogden, Yeoh, Polynomial

Type string

Example
The following example loads a material with experimental test data and a Neo-Hookean hyperelastic
property.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem()
engineeringData = system.GetContainer(ComponentName="Engineering Data")
neopreneRubber = engineeringData.ReadMaterial(
Name="Neoprene Rubber",
Source="Hyperelastic_Materials.xml")
neoHookeanProperty = neopreneRubber.GetProperty(Name="Neo-Hookean")
neoHookeanPropertyData = neoHookeanProperty.GetPropertyData(Name="Neo-Hookean")
curveFit = neoHookeanPropertyData.CreateCurveFitting(
Type="Neo-Hookean",
Definition="")
uniaxialProperty = neopreneRubber.GetProperty(Name="Uniaxial Test Data")
curveFit.AddTestData(TestData=uniaxialProperty)
biaxialProperty = neopreneRubber.GetProperty(Name="Biaxial Test Data")
curveFit.AddTestData(TestData=biaxialProperty)
shearProperty = neopreneRubber.GetProperty(Name="Shear Test Data")
curveFit.AddTestData(TestData=shearProperty)
volumetricProperty = neopreneRubber.GetProperty(Name="Volumetric Test Data")
curveFit.AddTestData(TestData=volumetricProperty)
curveFit.RemoveTestData(TestData=uniaxialProperty)
curveFit.AddTestData(TestData=uniaxialProperty)
curveFit.Solve()
curveFit.CopyCoefficients(Destination=neoHookeanPropertyData)
curveFit.Delete()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 345
Engineering Data

CreateVariable

Include an additional variable in the property data for a material property.

Return The new variable data that was created.

Type DataReference

Required Arguments

Name The new variable data name.

Type string

Optional Arguments

Qualifiers The optional dictionary of a qualifier name and it's corresponding value.

Type Dictionary<string, string>

Delete

Deletes the material property data.

EndBatchUpdate

Marks the completion of a series of data modifications.

GetChartData

Returns a generated graph data for the specified source data.

Valid source data are:

Material Property
Material Property Data

Return The graph data for the specified source data.

Type DataReference

GetCurveFitting

Query to return the DataReference to the CurveFit used by some PropertyData.

Return CurveFit DataReference

Type DataReference

GetVariable

Returns a material variable of a given name from a material property data.

Return The requested variable.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
346 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The name of the variable.

Type string

Example
The following example creates new Engineering Data system and queries Coefficient of Thermal Expansion
property data of the default material Structural Steel.

ENGDTemplate = GetTemplate(TemplateName="EngData")
ENGDSystem = ENGDTemplate.CreateSystem(Position="Default")

ENGDContainer = ENGDSystem.GetContainer(ComponentName="Engineering Data")

StructSteel = ENGDContainer.GetMaterial(Name="Structural Steel")

# Get material
CTEProperty = StructSteel.GetProperty(Name="Coefficient of Thermal Expansion")
# Get material property data
CTEPropData = CTEProperty.GetPropertyData(
Name="Coefficient of Thermal Expansion",
Definition="Secant",
Behavior="Isotropic")
# Get material variable
CTEVariable = CTEPropData.GetVariable(
Name="Coefficient of Thermal Expansion")

IsSuppressed

Checks if an entity is suppressed.

Valid entities are:

Material
Material Property
Material Property Data

Return Returns true if the entity is suppressed, false otherwise.

Type bool

IsValid

Validates a material property data and provides a message in case of invalid data.

Return The flag that indicates if the material property data is valid.

Type bool

Required Arguments

Material The parent material of the material property data.

Type DataReference

Optional Arguments

Message The validation failure message.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 347
Engineering Data

Type Output<string>

SetSuppression

Suppresses or Unsuppresses item.

Item can be suppressed to prevent it from being sent to a downstream cell in the system.

Following items can be suppressed:

Material

Material property

Material property data

Required Arguments

Suppressed The flag to specify if the item should be suppressed or unsuppressed.

Type bool

Engineering Data Favorite Library

The container used by Engineering Data to allow working with a library.

Methods
Close
Closes an Engineering Data library.

CreateMaterial
Adds a new material to the container.

Return The material data reference of the new material.

Type DataReference

Required Arguments

Name The name to be used for this material.

Type string

Export
Exports engineering data to the specified file.

The following type of file format is supported for export:

MatML 3.1 schema for Material(s)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
348 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

FilePath The target path for the Engineering Data file ("*.xml").

Type string

Format The file format in which engineering data will be exported.

Type string

UnitSystem The unit system in which engineering data will be exported.

Type string

Optional Arguments

ApplyScaleOffset The flag to specify if the scale factor and offset value will be applied during export.

Type bool

Default Value False

IgnoreSuppressed The flag to specify if suppressed engineering data will be ignored during export.

Type bool

Default Value False

OverwriteTarget The flag to specify if the target file will be overwritten.

Type bool

Default Value False

ReplaceMaterial The flag to specify if the earlier material data will be replaced in case of similar mater-
ial names.

Type bool

Default Value False

Example
template = GetTemplate(TemplateName="EngData") system = template.CreateSystem(Position="Default")
container = system.GetContainer(ComponentName="Engineering Data") materials = container.GetMater-
ials() EngData.WriteMaterials(MaterialList=materials, FilePath=r"d:\data\OutputMaterials.xml",
Format="MatML31", UnitSystem="MKS_STANDARD", ReplaceMaterial=true)

GetMaterial
Returns a material of a given name from a container.

The name matching is case insensitive. If a material is not found an exception is thrown.

Return The material that matches the specified name.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 349
Engineering Data

Required Arguments

Name The name of the material. This argument is case insensitive.

Type string

Example
The following example creates a new Engineering Data system and queries the default material, Structural
Steel.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem(Position="Default")
container = system.GetContainer(ComponentName="Engineering Data")
structuralSteel = container.GetMaterial(Name="Structural Steel")

GetMaterials
Returns the list of materials in a container. If no materials are in the container, the list is empty.

Return A DataReferenceSet of the materials in the container.

Type DataReferenceSet

Import
Imports engineering data into an existing source from a specified source.

The following types of files are supported for import:

Engineering Data libraries exported from Workbench 9.0 to 11.0 SP1

Material(s) file following the MatML 3.1 schema
Material(s) file generated by AUTODYN

Required Arguments

Source The source which contains the materials.

Type string

ImportMaterial
Reads the data for a single material into the requested container.

Return A DataReference for the material that was read.

Type DataReference

Required Arguments

Name The name of the material to read from the source.

Type string

Source The source which contains the requested material.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
350 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Example
This code shows how to read the Copper Alloy material from the provided samples, into Engineering Data
to use in an analysis.

installDir = r"C:\Program Files\ANSYS Inc\v121"

matl1 = engineeringData1.ReadMaterial(
Name="Copper Alloy",
Source=installDir+r"\Addins\EngineeringData\Samples\General_Materials.xml")

Refresh
This will repopulate the contents of an Engineering Data library with data from its source.

Save
Saves an Engineering Data library.

Optional Arguments

FilePath The optional string to specify the path if the Engineering Data library should be saved at different
location.

Type string

Data Entities
Material
The entity to store material information.

Properties
Description

The description of the material.

Type string

Read Only No

DisplayName

The display name of the material.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 351
Engineering Data

Type string

Read Only No

Source

The path of the material's source file ("*.engd" or "*.xml").

Type string

Read Only Yes

Methods
AddToFavorites

Adds an item to the Favorites item list.

CreateProperty

Includes a physical quantity or the constitutive relation for the physical response of a material. A property
can be visualized as one or more tables of data made up of one or more dependent and independent
variables.

The material property is created based on the specified optional parameters "Definition" and "Behavior".

Return Created material properly.

Type DataReference

Required Arguments

Name The new material property name.

Type string

Optional Arguments

Behavior The optional string to identify the way in which a new material property will behave.

Behavior of some material properties can be specified in different ways, e.g., Elasticity
can be specified as Isotropic, Orthotropic or Anisotropic.

Type string

Definition The optional string to identify the way in which new material property will be defined.

Some material properties are defined in different ways, e.g., Thermal Expansion can be
defined as Secant Coefficient of Thermal Expansion and Instantaneous Coefficient of
Thermal Expansion.

Type string

Qualifiers The optional dictionary of a qualifier name and it's corresponding value.

Type Dictionary<string, string>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
352 of ANSYS, Inc. and its subsidiaries and affiliates.
Example
The following example creates a new Engineering Data system and adds Coefficient of Thermal Expansion
and Elasticity material properties to the default material Structural Steel.

Coefficient of Thermal Expansion is created using Secant definition and Orthotropic behavior.
Elasticity is created using Orthotropic behavior.

ENGDTemplate = GetTemplate(TemplateName="EngData")
ENGDSystem = ENGDTemplate.CreateSystem(Position="Default")

ENGDContainer = ENGDSystem.GetContainer(ComponentName="Engineering Data")

StructSteel = ENGDContainer.GetMaterial(Name="Structural Steel")

# Create material properties

CTEProperty = StructSteel.CreateProperty(
Name="Coefficient of Thermal Expansion",
Definition="Secant",
Behavior="Orthotropic")
OrthoElasProperty = StructSteel.CreateProperty(
Name="Elasticity",
Behavior="Orthotropic")

Delete

Deletes the material.

Duplicate

Duplicates the data in this material and returns a new material. The name of the new material will be
appended with a numerical value to make it unique.

Return The material data reference of the duplicated material.

Type DataReference

Required Arguments

TargetContainer The duplicated material will be added to this container.

Type DataContainerReference

GetProperty

Returns a material property of a given name from the specified material.

Return The material property that matches the specified name.

Type DataReference

Required Arguments

Name The name of the material property.

Type string

Example
The following example creates new Engineering Data system and queries Coefficient of Thermal Expansion
property of the default material Structural Steel.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 353
Engineering Data

ENGDTemplate = GetTemplate(TemplateName="EngData")
ENGDSystem = ENGDTemplate.CreateSystem(Position="Default")

ENGDContainer = ENGDSystem.GetContainer(ComponentName="Engineering Data")

StructSteel = ENGDContainer.GetMaterial(Name="Structural Steel")

# Get material property

CTEProperty = StructSteel.GetProperty(Name="Coefficient of Thermal Expansion")

IsSuppressed

Checks if an entity is suppressed.

Valid entities are:

Material
Material Property
Material Property Data

Return Returns true if the entity is suppressed, false otherwise.

Type bool

IsValid

Validates a material data and provides a message in case of invalid data.

Return The flag that indicates if the material is valid.

Type bool

Optional Arguments

Message The validation failure message.

Type Output<string>

Refresh

This will repopulate the contents of a material with data from a given source. The NameInSource
property of a Material will be used to find a match in the source to pull data from. In the event that
NameInSource is not set, the DisplayName property will be used instead.

Note: This operation will cause destruction of any data currently in the material.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem(Position="Default")
container = system.GetContainer(ComponentName="Engineering Data")
structSteel = container.GetMaterial(Name="Structural Steel")
density = structSteel.GetProperty(Name="Density")
density.Delete()
structSteel.UpdateMaterial(Source="General_Materials.xml")
restoredDensity = structSteel.GetProperty(Name="Density")
restoredDensity.SetData(SheetName="", Index=0, Variables=["Density"], Values=[["8000 [kg m^-3]"]])

Required Arguments

Source The path of the source file.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
354 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

RemoveFromFavorites

Removes an item from the Favorite items list.

Optional Arguments

Format The format of the file that contains the item.

Type string

Material A DataReference to the Material to delete.

Type DataReference

Name The name of the item to delete.

Type string

Source The location of the file that contains the item on disk.

Type string

Type The type of the object to delete. This is either a Material or a Mixture.

Type EngineeringDataType

Example
The following example gets the list of favorites from Engineering Data. It then selects and deletes the "Gray
Cast Iron" material from the list.

favorites = EngData.LoadFavoriteItems()
matl = favorites.GetMaterial(Name="Gray Cast Iron")
EngData.DeleteFromFavorites(
Material=matl,
Type="Material")

SetAsDefaultFluidForModel

This will specify the material to use (or not use) for parts in the model which are marked as a fluid.

If the material is in the Engineering Data component it will set or unset the material to be used in the
model component of the system(s) that contain this Engineering Data component.

If the material is contained in Favorites it will set or unset the material to use as the default on fluids
in the Engineering Data component when a new system is added to the project.

The material is set as the default in Favorites. It will automatically be added to the list of project defaults.

Optional Arguments

Default This Boolean is used to set or unset the material as the default.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 355
Engineering Data

Default Value True

SetAsDefaultSolidForModel

This will specify the material to use (or not use) for parts in the model which are marked as a solid.

If the material is in the Engineering Data component it will set or unset the material to be used in the
model component of the system(s) that contain this Engineering Data component.

If the material is contained in Favorites it will set or unset the material to use as the default on solids
in the Engineering Data component when a new system is added to the project.

The material is set as the default in Favorites. It will automatically be added to the list of project defaults.

Optional Arguments

Default This Boolean is used to set or unset the material as the default.

Type bool

Default Value True

SetSuppression

Suppresses or Unsuppresses item.

Item can be suppressed to prevent it from being sent to a downstream cell in the system.

Following items can be suppressed:

Material

Material property

Material property data

Required Arguments

Suppressed The flag to specify if the item should be suppressed or unsuppressed.

Type bool

Unlink

Unlinks a material from its underlying source. Once this occurs, the material can no longer be restored
to its original state and the material will no longer have a source.

MaterialProperty
The entity to store material property information.

A material property is the identifier for the singular information (for example, Density) that together
with other properties defines or models the behavior of the material. A property is always defined by
at least one table (tabular data), which could be singular. Some properties can contain a collection of
tabular data (for example, Isotropic Elasticity).

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
356 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Behavior

The string that defines the way in which the material property behaves, e.g., Elasticity has Isotropic,
Orthotropic or Anisotropic behavior.

Type string

Read Only No

Definition

The definition of the material property. Some material properties are defined in different ways, e.g.,
Thermal Expansion can be defined as Secant Coefficient of Thermal Expansion and Instantaneous
Coefficient of Thermal Expansion.

Type string

Read Only No

Description

The description of the material property.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

PropertyDataColl

The collection of tabular data that defines the material property.

Type DataReferenceSet

Read Only Yes

TypeName

The name of the material property.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 357
Engineering Data

Methods
AddTestData

Includes experimental test data for response function calculations.

Required Arguments

TestData The test data property to add.

Type DataReference

BeginBatchUpdate

Marks the start of a series of data modifications to a table of data, to improve performance.

CreatePropertyData

Include an additional property data for a material property. Some properties may have more than one
property data to describe the material property.

The preferred method of adding a material property data is to use CreateMaterialProperty.

Return The new material properly data that was created.

Type DataReference

Required Arguments

Name The new material property data name.

Type string

Optional Arguments

Behavior A string to identify how the new material property data will behave.

The behavior of some material properties can be specified in different ways, e.g.,
Elasticity can be specified as Isotropic, Orthotropic or Anisotropic.

Type string

Definition A string to identify how the new material property data will be defined.

Some material properties are defined in different ways, e.g., Thermal Expansion can be
defined as Secant Coefficient of Thermal Expansion and Instantaneous Coefficient of
Thermal Expansion.

Type string

Qualifiers The optional dictionary of a qualifier name and it's corresponding value.

Type Dictionary<string, string>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
358 of ANSYS, Inc. and its subsidiaries and affiliates.
Example
The following example creates the material property data Orthotropic Secant Coefficient of Thermal Ex-
pansion on the material property Coefficient of Thermal Expansion. This example assumes the material
Structural Steel has been obtained from the General Materials library.

Get the material property we are going to create a new material property data on.

thermExpansionMatProp = structuralSteel.GetMaterialProperty(Name="Coefficient of Thermal Expansion")

Create the new material property data.

orthoSecantThermExpansionMatPropData = thermExpansionMatProp.CreatePropertyData(
Name="Coefficient of Thermal Expansion",
Definition="Secant",
Behavior="Orthotropic")

Delete

Deletes the material property.

Optional Arguments

Behavior The optional string to specify the material property behavior.

Behavior of some material properties can be specified in different ways e.g. Elasticity
can be specified as Isotropic, Orthotropic or Anisotropic.

Type string

Definition The optional string to specify the material property definition.

Some material properties are defined in different ways e.g. Thermal Expansion can be
defined as Secant Coefficient of Thermal Expansion and Instantaneous Coefficient of
Thermal Expansion.

Type string

DeleteData

Delete a row from a tabular data sheet.

Required Arguments

Index Index of the row to delete.

Type int

Optional Arguments

SheetName Name of the sheet to access.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 359
Engineering Data

SheetQualifiers SheetQualifiers is used to pass in the qualifiers to select between multiple sheets witht
the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

Example
The following example illustrates the deletion of a row from a tabular data sheet.

#
# Create a new Engineering Data System and access Structural Steel
#
template1 = GetTemplate(TemplateName="EngData")
system1 = template1.CreateSystem()
engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
#
# Delete the first row in the Density property
#
matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.DeleteTabularDataRow(Index = 0)
#
# Delete the first row in the Coefficient of Thermal Expansion property with optional SheeetNamea nd SheetQ
#
matlProp2 = matl1.GetProperty(Name="Coefficient of Thermal Expansion")
matlProp2.DeleteTabularDataRow(
SheetName="Coefficient of Thermal Expansion",
SheetQualifiers={"Definition Method": "Secant", "Behavior": "Isotropic"},
Index = 0)

EndBatchUpdate

Marks the completion of a series of data modifications.

GetChartData

Returns a generated graph data for the specified source data.

Valid source data are:

Material Property
Material Property Data

Return The graph data for the specified source data.

Type DataReference

GetData

Returns the tabular data associated with the data entity.

Return The returned data in scalar, list, or dictionary format.

Type Object

Optional Arguments

AsDictionary If set to true, the data will be returned as a dictionary where the keys are variable names
and the values are the data for each variable. If set to false, the data will be returned
in scalar or list format without the variable names.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
360 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type bool

Default Value False

ColumnMajor If set to true, the data will be returned in column-major order. If set to false, the data
will be returned in row-major order.

Type bool

Default Value True

EndIndex The end index for requesting a subset of the data (zero-based).

Type int

Default Value -2147483647

SheetName Specifies the sheet name when the data contains multiple sheets.

Type string

SheetQualifiers Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.

Type Dictionary<string, string>

StartIndex The start index for requesting a subset of the data (zero-based).

Type int

Default Value 0

Variables Names of the variables for which data is requested (string or list of strings).

Type Object

Example
In this example, all data is requested for the given tabular data entity.

tabData1.GetData()

In this example, all data is requested in row-major order.

tabData1.GetData(ColumnMajor=False)

In this example, all data is requested in dictionary format.

tabData1.GetData(AsDictionary=True)

In this example, data for variables Density and Temperature is requested in dictionary format.

tabData1.GetData(Variables=["Density", "Temperature"], AsDictionary=True)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 361
Engineering Data

GetPropertyData

Returns a property data of the specified material property.

The property data returned is based on specified optional parameters "Definition" and "Behavior".

Return The material property data that matches specified type name, definition and behavior.

Type DataReference

Required Arguments

Name The material property data type name.

Type string

Optional Arguments

Behavior The optional string to specify the material property data behavior.

Behavior of some material properties can be specified in different ways, e.g., Elasticity
can be specified as Isotropic, Orthotropic or Anisotropic.

Type string

Definition The optional string to specify the material property data definition.

Some material properties are defined in different ways, e.g., Thermal Expansion can be
defined as Secant Coefficient of Thermal Expansion and Instantaneous Coefficient of
Thermal Expansion.

Type string

Qualifiers The optional dictionary of a qualifier name and it's corresponding value.

Type Dictionary<string, string>

Example
The following example creates new Engineering Data system and queries Coefficient of Thermal Expansion
property data of the default material Structural Steel.

ENGDTemplate = GetTemplate(TemplateName="EngData")
ENGDSystem = ENGDTemplate.CreateSystem(Position="Default")

ENGDContainer = ENGDSystem.GetContainer(ComponentName="Engineering Data")

StructSteel = ENGDContainer.GetMaterial(Name="Structural Steel")

#Get material property

CTEProperty = StructSteel.GetProperty(Name="Coefficient of Thermal Expansion")
# Get material property data
CTEPropData = CTEProperty.GetPropertyData(
Name="Coefficient of Thermal Expansion",
Definition="Secant",
Behavior="Isotropic")
RefTempPropData = CTEProperty.GetPropertyData(
Name="Reference Temperature",
Definition="Secant",
Behavior="Isotropic")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
362 of ANSYS, Inc. and its subsidiaries and affiliates.
IsSuppressed

Checks if an entity is suppressed.

Valid entities are:

Material
Material Property
Material Property Data

Return Returns true if the entity is suppressed, false otherwise.

Type bool

IsValid

Validates a material property and provides a message in case of invalid data.

Return The flag that indicates if the material property is valid.

Type bool

Required Arguments

Material The parent material of the property.

Type DataReference

Optional Arguments

Message The validation failure message.

Type Output<string>

RemoveTestData

Excludes experimental test data for response function calculations.

Required Arguments

TestData The test data property to add.

Type DataReference

SetData

Set tabular data associated with the data entity.

Optional Arguments

Data Sets the data using a dictionary form. The keys are the variable names and the values
are the data. The use of this argument is mutually exclusive with "Values" and "Vari-
ables".

Type Dictionary<string, List<Object>>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 363
Engineering Data

Index Specifies the starting location used to set the data (zero-based). A value of -1 indicates
that the data should be appended to the existing data.

Type int

Default Value 0

SheetName Specifies the sheet name when the data contains multiple sheets.

Type string

SheetQualifiers Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.

Type Dictionary<string, string>

Values List of data values set in conjunction with the "Variables" parameter. This parameter
and the "Data" parameter are mutually exclusive.

Type List<List<Object>>

Variables Names of the variables for which data is being set. This parameter and and the "Data"
parameter are mutually exclusive.

Type List<string>

Example

#
# Create a new Engineering Data System and access Structural Steel
#
template1 = GetTemplate(TemplateName="EngData")
system1 = template1.CreateSystem()
engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
#
# Change the value of a simple single-valued property
#
matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.SetData(
Variables="Density",
Values="8500 [kg m^-3]")
#
# Set Temperature-dependent data for Elasticity based
# on lists of variables and values.
matlProp2 = matl1.GetProperty(Name="Elasticity")
temperature = ["400 [K]", "600 [K]", "800 [K]"]
E = ["2e5 [MPa]", "1.9e5 [MPa]", "1.6e5 [MPa]"]
matlProp2.SetData(
Variables = ["Temperature","Young's Modulus"],
Values = [temperature, E])
#
# Change the Temperature for the second table entry.
#
matlProp2.SetData(
Index = 1,
Variables = "Temperature",
Values = "625 [K]")
#
# Set a list for Poisson's Ratio starting at the second table entry.
#
matlProp2.SetData(
Index = 1,
Variables = "Poisson's Ratio",

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
364 of ANSYS, Inc. and its subsidiaries and affiliates.
 Values = [0.3, 0.3])
#
# Set Temperature-dependent property data for the Coefficient of Thermal Expansion
# using a dictionary. The dictionary key is the Variable name,
# followed by the list of values for the variable.
#
matlProp3 = matl1.GetProperty(Name="Coefficient of Thermal Expansion")
newData = {"Temperature": ["200 [F]","400 [F]","600 [F]","800 [F]","1000 [F]"],
"Coefficient of Thermal Expansion" : ["6.3e-6 [F^-1]", "7.0e-6 [F^-1]",
"7.46e-6 [F^-1]", "7.8e-6 [F^-1]",
"8.04e-6 [F^-1]"]}
matlProp3.SetData(
SheetName="Coefficient of Thermal Expansion",
SheetQualifiers={"Definition Method": "Secant", "Behavior": "Isotropic"},
Data = newData)

SetQualifier

Changes the values of a specifiec qualifier in a data table.

Required Arguments

Qualifier The Qualifier to Set.

Type string

Value The new value.

Type string

Optional Arguments

SheetName The name of the tabular data sheet that contains the qualifier.

Type string

SheetQualifiers SheetQualifiers can be used to pass in the qualifiers to select between multiple
sheets witht the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

VariableName The name of the Variable that contains the qualifier to be changed.

Type string

VariableQualifiers VariableQualifiers can used to pass in the qualifiers to select between multiple
variables witht the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

Example
The following example changes the 'Derive From' setting within an Isotropic Elasticity material property
to be "Bulk Modulus and Poisson's Ratio".

matl1 = engineeringData1.GetMaterial(Name="Structural Steel")

matlProp1 = matl1.GetProperty(Name="Elasticity")
matlProp1.SetQualifier(
SheetName="Elasticity",
Qualifier="Derive from",

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 365
Engineering Data

Value="Bulk Modulus and Poisson's Ratio")

SetSuppression

Suppresses or Unsuppresses item.

Item can be suppressed to prevent it from being sent to a downstream cell in the system.

Following items can be suppressed:

Material

Material property

Material property data

Required Arguments

Suppressed The flag to specify if the item should be suppressed or unsuppressed.

Type bool

MaterialPropertyData
The entity to store material property (tabular) data information. The material property data is a collection
of material variable data.

Properties
Behavior

The behavior of the material variable tabular data. Some material properties can have different behavior,
e.g., Elasticity has Isotropic, Orthotropic or Anisotropic behavior.

Type string

Read Only No

Definition

The definition of the material variable tabular data. Some material properties are defined in different
ways, e.g., Thermal Expansion can be defined as Secant Coefficient of Thermal Expansion and Instant-
aneous Coefficient of Thermal Expansion.

Type string

Read Only No

DependentColl

The collection of dependent variables in the material variable tabular data, e.g., Density.

Type DataReferenceSet

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
366 of ANSYS, Inc. and its subsidiaries and affiliates.
Description

The description of the material variable tabular data.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IndependentColl

The collection of independent variables in the material variable tabular data, e.g., Temperature.

Type DataReferenceSet

Read Only Yes

PrimaryIndependent

The primary independent variable in the material variable tabular data, e.g., Temperature.

Type DataReference

Read Only Yes

RowsCount

The number of data values for a variable in the material variable tabular data.

Type int

Read Only Yes

TypeName

The name of the material variable tabular data.

Type string

Read Only No

VariableColl

The collection of variables in the material variable tabular data.

Type DataReferenceSet

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 367
Engineering Data

Methods
BeginBatchUpdate

Marks the start of a series of data modifications to a table of data, to improve performance.

CreateCurveFitting

Creates a curve fitting for a given property data.

Return The curve fitting.

Type DataReference

Required Arguments

Definition The definition of curve fitting to create. This must be a definition that is supported by an en-
gineering data curve fitting.

i.e. 1 Parameter, 2 Parameter, 1st Order, 2nd Order

Type string

Type The type of curve fitting to create. This must be a type that is supported by an engineering
data curve fitting.

i.e. Neo-Hookean, Mooney-Rivlin, Ogden, Yeoh, Polynomial

Type string

Example
The following example loads a material with experimental test data and a Neo-Hookean hyperelastic
property.

template = GetTemplate(TemplateName="EngData")
system = template.CreateSystem()
engineeringData = system.GetContainer(ComponentName="Engineering Data")
neopreneRubber = engineeringData.ReadMaterial(
Name="Neoprene Rubber",
Source="Hyperelastic_Materials.xml")
neoHookeanProperty = neopreneRubber.GetProperty(Name="Neo-Hookean")
neoHookeanPropertyData = neoHookeanProperty.GetPropertyData(Name="Neo-Hookean")
curveFit = neoHookeanPropertyData.CreateCurveFitting(
Type="Neo-Hookean",
Definition="")
uniaxialProperty = neopreneRubber.GetProperty(Name="Uniaxial Test Data")
curveFit.AddTestData(TestData=uniaxialProperty)
biaxialProperty = neopreneRubber.GetProperty(Name="Biaxial Test Data")
curveFit.AddTestData(TestData=biaxialProperty)
shearProperty = neopreneRubber.GetProperty(Name="Shear Test Data")
curveFit.AddTestData(TestData=shearProperty)
volumetricProperty = neopreneRubber.GetProperty(Name="Volumetric Test Data")
curveFit.AddTestData(TestData=volumetricProperty)
curveFit.RemoveTestData(TestData=uniaxialProperty)
curveFit.AddTestData(TestData=uniaxialProperty)
curveFit.Solve()
curveFit.CopyCoefficients(Destination=neoHookeanPropertyData)
curveFit.Delete()

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
368 of ANSYS, Inc. and its subsidiaries and affiliates.
CreateVariable

Include an additional variable in the property data for a material property.

Return The new variable data that was created.

Type DataReference

Required Arguments

Name The new variable data name.

Type string

Optional Arguments

Qualifiers The optional dictionary of a qualifier name and it's corresponding value.

Type Dictionary<string, string>

Delete

Deletes the material property data.

EndBatchUpdate

Marks the completion of a series of data modifications.

GetChartData

Returns a generated graph data for the specified source data.

Valid source data are:

Material Property
Material Property Data

Return The graph data for the specified source data.

Type DataReference

GetCurveFitting

Query to return the DataReference to the CurveFit used by some PropertyData.

Return CurveFit DataReference

Type DataReference

GetVariable

Returns a material variable of a given name from a material property data.

Return The requested variable.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 369
Engineering Data

Required Arguments

Name The name of the variable.

Type string

Example
The following example creates new Engineering Data system and queries Coefficient of Thermal Expansion
property data of the default material Structural Steel.

ENGDTemplate = GetTemplate(TemplateName="EngData")
ENGDSystem = ENGDTemplate.CreateSystem(Position="Default")

ENGDContainer = ENGDSystem.GetContainer(ComponentName="Engineering Data")

StructSteel = ENGDContainer.GetMaterial(Name="Structural Steel")

# Get material
CTEProperty = StructSteel.GetProperty(Name="Coefficient of Thermal Expansion")
# Get material property data
CTEPropData = CTEProperty.GetPropertyData(
Name="Coefficient of Thermal Expansion",
Definition="Secant",
Behavior="Isotropic")
# Get material variable
CTEVariable = CTEPropData.GetVariable(
Name="Coefficient of Thermal Expansion")

IsSuppressed

Checks if an entity is suppressed.

Valid entities are:

Material
Material Property
Material Property Data

Return Returns true if the entity is suppressed, false otherwise.

Type bool

IsValid

Validates a material property data and provides a message in case of invalid data.

Return The flag that indicates if the material property data is valid.

Type bool

Required Arguments

Material The parent material of the material property data.

Type DataReference

Optional Arguments

Message The validation failure message.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
370 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type Output<string>

SetSuppression

Suppresses or Unsuppresses item.

Item can be suppressed to prevent it from being sent to a downstream cell in the system.

Following items can be suppressed:

Material

Material property

Material property data

Required Arguments

Suppressed The flag to specify if the item should be suppressed or unsuppressed.

Type bool

MaterialVariable
The entity to store material variable information.

Properties
DatumColl

The collection of the material variable data.

Type DataReferenceSet

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsDependent

The flag that indicates if the material variable is dependent, e.g., Density is temperature dependent.

Type bool

Read Only No

LowerBoundUnit

The unit of the lower bound data value in the material variable data.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 371
Engineering Data

Type string

Read Only No

LowerBoundValue

The lower bound data value in the material variable data.

Type double

Read Only No

MaxValue

The maximum value limit of the material variable data.

Type double

Read Only No

MinValue

The minimum value limit of the material variable data.

Type double

Read Only No

Offset

The offset value of the material variable data.

Type Quantity

Read Only No

Scale

The scale factor of the material variable data.

Type double

Read Only No

TypeName

The name of the material variable.

Type string

Read Only No

UniqueData

The collection of unique data values in the material variable data.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
372 of ANSYS, Inc. and its subsidiaries and affiliates.
Type DataReferenceSet

Read Only No

UpperBoundUnit

The unit of the upper bound data value in the material variable data.

Type string

Read Only No

UpperBoundValue

The upper bound data value in the material variable data.

Type double

Read Only No

Methods
Delete

Deletes an additional variable in the property data from a material property.

IsValid

Validates a material variable data and provides a message in case of invalid data.

Return The flag that indicates if the material variable is valid.

Type bool

Required Arguments

Material The parent material of the variable.

Type DataReference

MaterialPropertyData The parent material property data of the variable.

Type DataReference

Optional Arguments

Message The validation failure message.

Type Output<string>

Example
template = GetTemplate(TemplateName="EngData") system = template.CreateSystem(Position="Default")
container = system.GetContainer(ComponentName="Engineering Data") structSteel = container.GetMater-
ial(Name="Structural Steel") CTEProp = structSteel.GetProperty(Name="Coefficient of Thermal Expansion")
CTEPropData = CTEProperty.GetPropertyData( Name="Coefficient of Thermal Expansion", Definition="Sec-
ant", Behavior="Isotropic") CTEVariable = CTEPropData.GetVariable( Name="Coefficient of Thermal Expan-

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 373
Engineering Data

sion") valid = EngData.ValidateMaterialVariable(MaterialVariable=CTEVariable, Material=structSteel, Mater-

ialPropertyData=CTEPropdata)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
374 of ANSYS, Inc. and its subsidiaries and affiliates.
External Connection

External Connection
This container hold data for an instance of the External Process Connector.

Methods
ExecuteOperation
Command that wraps the script invoked by a custom GUI Operation

Required Arguments

Operation The name of the operation to execute

Type string

GetExternalConnectionProperties
A Query to return a reference to the ExternalConnectionProperties entity

Return A reference to the requested data entity.

Type DataReference

ReadConfiguration
Reads a External Connection configuration file.

Required Arguments

FilePath The full path to the configuration file.

Type string

ReadParameterValues
Populates all the values of the parameters of a given type within a container.

Required Arguments

ParameterType Type of parameter. Should be "input" or "output".

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 375
External Connection

Data Entities
ExternalConnectionProperties
This entity holds the properties used to connect a Workbench project to an external process or applic-
ation.

Properties
ConfigFile

The path to the configuration file defining application settings.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

WorkingDirectory

The path to the working directory. This is optional. If this value is not set, it defaults to the add-in dir-
ectory corresponding to the system ("project_files/dpN/sysDir/addinDir")

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
376 of ANSYS, Inc. and its subsidiaries and affiliates.
External Data

External Data
This container holds data to expose external results or data files within the Workbench project.

Methods
AddDataFile
Adds a data file to the outline

Return Returns the reference to the FileData object

Type DataReference

Required Arguments

FilePath The data file path

Type string

AddRepositoryFile
Adds a data file to the outline

Return Returns the reference to the FileData object

Type DataReference

Required Arguments

File The repository file

Type DataReference

Index Inserts the data files in the specified location in the internal list. It is 0-based.

Type int

GetExternalLoadData
Query to return the reference to the container's ExternalLoadData data entity.

Return A reference to the requested ExternalLoadData data entity.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 377
External Data

GetExternalLoadOutput
Query to return the reference to the container's ExternalDataOutput data entity.

Return A reference to the requested ExternalLoadData data entity.

Type DataReference

InsertDataFile
Adds a data file to the outline

Return Returns the reference to the FileData object

Type DataReference

Required Arguments

FilePath The data file path

Type string

Index Inserts the data files in the specified location in the internal list. It is 0-based.

Type int

ModifyRepositoryFile
Changes the file path of the existing FileData

Required Arguments

FileData Reference to the FileData to be modified

Type DataReference

RepositoryFile File to be modified in the FileData

Type DataReference

RereadDataFiles
When you modify an External Data system's data file outside of the Workbench and you need to cause
the Workbench to re-read the data file.

ScanForFileChanges
This command is useful, when you modify an External Data system's data file outside of the Workbench
and you need to cause the Workbench to re-read the data file.

Data Entities
ExternalLoadColumnData
This entity contains information about the column data

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
378 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
DataType

DataType of this column data

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Identifier

Identifier of this column data. This will be used by the down stream applications

Type string

Read Only No

Unit

Unit of this column data

Type string

Read Only No

ExternalLoadData
This is the root level entity for the external data add-in

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FilesData

Cotnains the List of FileData references

Type List<DataReference>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 379
External Data

Read Only No

Methods
DeleteFileData

Removes a data file from the outline

Required Arguments

FileData Reference to the FileData

Type DataReference

DuplicateFileData

Removes a data file from the outline

Required Arguments

FileData Reference to the FileData

Type DataReference

GetExternalLoadFileData

Query to return the reference to the container's ExternalLoadFileData data entity.

Return A reference to the requested ExternalLoadFileData data entity.

Type DataReference

Required Arguments

Name Name of the ExternalLoadFileData entity

Type string

ExternalLoadFileData
This entity contains information for the DataFile added to the outline

Properties
Description

Contains the description about the Data file

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
380 of ANSYS, Inc. and its subsidiaries and affiliates.
Type string

Read Only No

File

FileReference maintained by the project

Type DataReference

Read Only No

FileDataProperty

Contains the refernce to the FileDataPoperty

Type DataReference

Read Only No

Master

Makes the Data file as a Master or not. Only one Data file can be a Master.

Type bool

Read Only No

Methods
GetDataProperty

Query to return the reference to the container's ExternalLoadFileDataProperty data entity.

Return A reference to the requested ExternalLoadFileData data entity.

Type DataReference

ModifyFileData

Changes the file path of the existing FileData

Required Arguments

FilePath FilePath to be modified in the FileData

Type string

SetAsMaster

Changes the Master property on the FileData

Required Arguments

Master controls the whether to make it as Master or not

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 381
External Data

Type bool

SetDelimiterCharacter

Changes the Delimited Character on the FileDataProperty

Required Arguments

Delimiter New Delimiter for the FileDataProperty

Type string

FileDataProperty FileDataProperty that needs to be modified

Type DataReference

SetDelimiterType

Changes the DelimiterType on the FileDataProperty

Required Arguments

Delimiter New DelimiterType for the FileDataProperty

Type DelimiterType

DelimiterString New Delimiter string for the FileDataProperty

Type string

FileDataProperty FileDataProperty that needs to be modified

Type DataReference

Example

solution1.SetDelimiterType(
FileData=fileData,
FileDataProperty=fileDataProperty,
Delimiter=DelimiterType.Comma,
DelimiterString=",")

SetFormatType

Changes the FormatType on the FileDataProperty

Required Arguments

FileDataProperty FileDataProperty that needs to be modified

Type DataReference

Type New Format Type for the FileDataProperty

Type FormatType

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
382 of ANSYS, Inc. and its subsidiaries and affiliates.
SetStartImportAtLine

Changes the Start Import at Line on the FileDataProperty

Required Arguments

FileDataProperty FileDataProperty that needs to be modified

Type DataReference

LineNumber New LineNumber for the FileDataProperty

Type int

ExternalLoadFileDataProperty
Contains information displayed on the properties view

Properties
ColumnsData

Contains the list references to the Column Data

Type List<DataReference>

Read Only No

ConversionOption

Contains the option on how to convert the data

Type VariableConversionOption

Read Only No

CoordinateSystemType

Specifies whether to use the Cartesian or Cylindrical coordinate system. The default value is Cartesian

Type CoordinateSystemType

Read Only No

DelimiterCharacter

Contains the delimiter character. Based on this value, number of columns are calculated

Type string

Read Only No

DelimiterType

Contains either the predefined delimiter or the user defined delimiter type

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 383
External Data

Type DelimiterType

Read Only No

Dimensions

You can choose to either import data from 2D or 3D models. If the 2D option is selected, you will be
able to import data only at the X and Y coordinates. The Z coordinate is not supported for the 2D option.

Type DimensionsType

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FileIdentifier

A string that can be used to identify the file in the downstream Mechanical application. The data iden-
tifiers, from the Table pane, are appended to this string so that you can pick the correct source data in
the downstream Mechanical application.

Type string

Read Only No

FormatString

Contains the FormatString. Based on this value, number of columns are calculated

Type string

Read Only No

FormatType

This can be either Delimited or User-Defined. If the value is Delimited - Delimiter Character field is valid
If the value is User-Defined - FormatString field is valid

Type FormatType

Read Only No

LengthUnit

The units of measurement to be used.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
384 of ANSYS, Inc. and its subsidiaries and affiliates.
OriginX

Contains the OriginX value

Type double

Read Only No

OriginXUnit

Contains the unit of the OriginX

Type string

Read Only No

OriginY

Contains the OriginY value

Type double

Read Only No

OriginYUnit

Contains the unit of the OriginY

Type string

Read Only No

OriginZ

Contains the OriginZ value

Type double

Read Only No

OriginZUnit

Contains the unit of the OriginZ

Type string

Read Only No

ScaleX

Contains the Scale X string

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 385
External Data

ScaleXToolTip

Contains the tool tip of the Scale X

Type string

Read Only No

ScaleXValid

Contains the whether the Scale X string is valid or not

Type bool

Read Only No

ScaleY

Contains the Scale Y string

Type string

Read Only No

ScaleYToolTip

Contains the tool tip of the Scale Y

Type string

Read Only No

ScaleYValid

Contains the whether the Scale Y string is valid or not

Type bool

Read Only No

ScaleZ

Contains the Scale Z string

Type string

Read Only No

ScaleZToolTip

Contains the tool tip of the Scale Z

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
386 of ANSYS, Inc. and its subsidiaries and affiliates.
ScaleZValid

Contains the whether the Scale Z string is valid or not

Type bool

Read Only No

StartImportAtLine

The line number at which you want the data import to start. Line numbers start at 1.

Type int

Read Only No

ThetaXY

Contains the ThetaXY value

Type double

Read Only No

ThetaXYUnit

Contains the unit of the ThetaXY

Type string

Read Only No

ThetaYZ

Contains the ThetaYZ value

Type double

Read Only No

ThetaYZUnit

Contains the unit of the ThetaYZ

Type string

Read Only No

ThetaZX

Contains the ThetaZX value

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 387
External Data

ThetaZXUnit

Contains the unit of the ThetaZX

Type string

Read Only No

Methods
GetColumnData

Query to return the reference to the container's ExternalLoaColumndData data entity.

Return A reference to the requested ExternalLoadFileData data entity.

Type DataReference

Required Arguments

Name Name of the ExternalLoadColumnData entity

Type string

SetColumnDataType

Changes the column data type of the given ColumnData

Required Arguments

ColumnData ColumnData to be mofied

Type DataReference

DataType New DataType for the ColumnData

Type string

SetCoordinateSystemType

Changes the CoordinateSystem type in the FileDataProperty

Required Arguments

Type New Coordinate System Type for the FileDataProperty

Type CoordinateSystemType

SetDimensionLengthUnit

Changes the Data Type on the specified X,Y,Z coordinate

Required Arguments

Coordinate Coordinate X,Y,Z

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
388 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Unit New Length Unit for the FileDataProperty

Type string

SetDimensionType

Changes the DimensionsType on the FileDataProperty

Required Arguments

Dimensions New DimensionsType for the FileDataProperty

Type DimensionsType

SetFormatString

Changes the FormatString on the FileDataProperty

Required Arguments

Format New Format string for the FileDataProperty

Type string

SetLengthUnit

Changes the Length Unit on the FileDataProperty

Required Arguments

Unit New Length Unit for the FileDataProperty

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 389
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
390 of ANSYS, Inc. and its subsidiaries and affiliates.
External Model Setup

External Model Setup

This container holds data to expose external model setup data within the Workbench project.

Methods
AddDataFile
Adds a data file to the outline

Return Returns the reference to the FileData object

Type DataReference

Required Arguments

FilePath The data file path

Type string

AddRepositoryFile
Adds a data file to the outline

Return Returns the reference to the FileData object

Type DataReference

Required Arguments

File The repository file

Type DataReference

Index Inserts the data files in the specified location in the internal list. It is 0-based.

Type int

GetExternalModelData
Query to return the reference to the container's ExternalLoadData data entity.

Return A reference to the requested ExternalLoadData data entity.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 391
External Model Setup

GetExternalModelOutput
Query to return the reference to the container's ExternalDataOutput data entity.

Return A reference to the requested ExternalLoadData data entity.

Type DataReference

InsertDataFile
Adds a data file to the outline

Return Returns the reference to the FileData object

Type DataReference

Required Arguments

FilePath The data file path

Type string

Index Inserts the data files in the specified location in the internal list. It is 0-based.

Type int

ModifyRepositoryFile
Changes the file path of the existing FileData

Required Arguments

FileData Reference to the FileData to be modified

Type DataReference

RepositoryFile File to be modified in the FileData

Type DataReference

RereadDataFiles
When you modify an External Model system's data file outside of the Workbench and you need to cause
the Workbench to re-read the data file.

ScanForFileChanges
This command is useful, when you modify an External Data system's data file outside of the Workbench
and you need to cause the Workbench to re-read the data file.

Data Entities
ExternalModelData
This is the root level entity for the external data add-in

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
392 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FilesData

Cotnains the List of FileData references

Type List<DataReference>

Read Only No

Methods
DeleteFileData

Removes a data file from the outline

Required Arguments

FileData Reference to the FileData

Type DataReference

DuplicateFileData

Removes a data file from the outline

Required Arguments

FileData Reference to the FileData

Type DataReference

GetExternalModelFileData

Query to return the reference to the container's ExternalLoadFileData data entity.

Return A reference to the requested ExternalLoadFileData data entity.

Type DataReference

Required Arguments

Name Name of the ExternalModelFileData entity

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 393
External Model Setup

ExternalModelFileData
This entity contains information for the DataFile added to the outline

Properties
Description

Contains the description about the Data file

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

File

FileReference maintained by the project

Type DataReference

Read Only No

FileDataProperty

Contains the refernce to the FileDataPoperty

Type DataReference

Read Only No

Methods
GetDataProperty

Query to return the reference to the container's ExternalLoadFileDataProperty data entity.

Return A reference to the requested ExternalLoadFileData data entity.

Type DataReference

ModifyFileData

Changes the file path of the existing FileData

Required Arguments

FilePath FilePath to be modified in the FileData

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
394 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

ExternalModelFileDataProperty
Contains information displayed on the properties view

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ElementOffset

Number to offset mesh elements by

Type int

Read Only No

LengthUnit

The units of measurement to be used.

Type string

Read Only No

NodeAndElementRenumberingMethod

By default this value is Automatic, specifies whether the user would like us to automatically renumber
his mesh elements to prevent unique id conflicts during assembly

Type NodeAndElementRenumberingMethodType

Read Only No

NodeOffset

Number to offset mesh nodes by

Type int

Read Only No

NumberOfCopies

Number of copies to be created by downstream consumer

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 395
External Model Setup

Read Only No

OriginX

Contains the OriginX value

Type double

Read Only No

OriginXUnit

Contains the unit of the OriginX

Type string

Read Only No

OriginY

Contains the OriginY value

Type double

Read Only No

OriginYUnit

Contains the unit of the OriginY

Type string

Read Only No

OriginZ

Contains the OriginZ value

Type double

Read Only No

OriginZUnit

Contains the unit of the OriginZ

Type string

Read Only No

ThetaXY

Contains the ThetaXY value

Type double

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
396 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

ThetaXYUnit

Contains the unit of the ThetaXY

Type string

Read Only No

ThetaYZ

Contains the ThetaYZ value

Type double

Read Only No

ThetaYZUnit

Contains the unit of the ThetaYZ

Type string

Read Only No

ThetaZX

Contains the ThetaZX value

Type double

Read Only No

ThetaZXUnit

Contains the unit of the ThetaZX

Type string

Read Only No

TransformOriginal

Whether or not we are going to transform the first instance of the model

Type bool

Read Only No

Methods
SetLengthUnit

Changes the Length Unit on the FileDataProperty

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 397
External Model Setup

Required Arguments

Unit New Length Unit for the FileDataProperty

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
398 of ANSYS, Inc. and its subsidiaries and affiliates.
Finite Element Modeler

Finite Element Modeler

This container holds data for an instance of the Finite Element Modeler.

Methods
AddMeshFile
This command adds a Mesh File to the input meshes collection of the specified Container. Note that
we allow the User to import the same file multiple times. Finally, note that the default Unit System will
be the one of the Assembly Mesh.

Return The newly added Input Mesh.

Type DataReference

Required Arguments

FilePath The input mesh file path.

Type string

ModelType The format of the input mesh file.

Type ModelType

Edit
This command will launch the FE Modeler Editor (if not already running) and will either import the list
of input meshes or open the currently existing database. Note that the Editor can be run in either Inter-
active mode or Batch mode.

Optional Arguments

Interactive An optional boolean (True by default) which indicates if the Editor must be launched in In-
teractive mode (with a GUI so that the User can interact with it). If False, the Editor is run in
Batch mode.

Type bool

Default Value True

Exit
The Exit command will close the potentially opened Editor associated with the Container argument.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 399
Finite Element Modeler

GetFEMInputMesh
Returns the reference of one of the container's InputMesh data entity. Note that you will retrieve one
of its specialized classes: FEMUpstreamInputMesh or FEMUserInputMesh

Return The reference of the InputMesh data entity

Type DataReference

Required Arguments

Name Name of the input mesh

Type string

GetFEMMesh
Returns the reference of the container's FEMMesh data entity.

Return The reference of the FEMMesh data entity

Type DataReference

Required Arguments

Name Name of the entity

Type string

GetFEMModel
Returns the reference of the container's FEMModel data entity.

Return The reference of the FEMModel data entity

Type DataReference

Required Arguments

Name Name of the entity

Type string

GetFEMSetup
Returns the reference of the container's FEMSetup data entity.

Return The reference of the FEMSetup data entity

Type DataReference

Required Arguments

Name Name of the entity

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
400 of ANSYS, Inc. and its subsidiaries and affiliates.
GetGeometry
Returns the reference of the container's FEMGeometry data entity.

Return The reference of the FEMGeometry data entity

Type DataReference

Required Arguments

Name Name of the entity

Type string

SendCommand
The SendCommand command will execute the script contents, specified in Command, in the FE
Modeler Editor associated with the specified Container. Note that if the associated FE Modeler Editor
is not running when this command is issued, it will be launched and eventually closed at the end of
the command. This command requires the Editor (if already up and running) not to be busy.

Required Arguments

Com- Command argument containing the command.

mand
Type string

Data Entities
FEMInputMesh
This object represents an input mesh for the FE Model. This input mesh can either be a Mesh File added
by the User or data coming from an upstream container through a connection. In the first case, the
object will be of type 'UserInputMeshObject' ; in the other case, the object will be of type 'UpstreamIn-
putMeshObject'. Many useful properties can be retrieved from this input mesh object.

Properties
BodyGrouping

The body grouping property of the input mesh (when importing it from a file). This entity is displayed
as a Property for the User to modify.

Type BodyGrouping

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 401
Finite Element Modeler

FileFormat

The format of the mesh file. Even if the input type is an upstream connection, there is an associated
transfer file.

Type ModelType

Read Only Yes

FileReference

The file reference of the mesh file. Even if the input type is an upstream connection, there is an associated
tranfer file.

Type DataReference

Read Only Yes

IDHandling

The ID Handling property of the input mesh. This entity is displayed as a Property for the User to
modify.

Type IDHandling

Read Only No

UnitSystem

The Unit System of the input mesh (when importing it from a file). This entity is displayed as a Property
for the User to modify.

Type String[]

Read Only No

Methods
Delete

This method removes an existing input mesh from an FE Modeler Model component.

SwitchInputOrder

This method switches the displayed order of two input meshes in the collection of an FE Modeler
Model component.

Required Arguments

OtherInputFile The reference of the second input mesh to switch

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
402 of ANSYS, Inc. and its subsidiaries and affiliates.
FEMMesh
This output object is used for transferring the mesh associated with the generated Faceted representation
of the Geometry. The mesh data will be stored in an ACMO-formatted file whose reference can be re-
trieved using the 'ACMOFile' public property. Note that this mesh can be morphed if a Parametric study
has been performed in the FE Modeler Editor.

Properties
ACMOFile

The reference of the ACMO file representing the Associated Mesh of the Faceted Geometry.

Type DataReference

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FEMModel
This object represents the Assembly Mesh as well as the main storage location for some internal data
for the container.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

GeometryImportAnalysisType

Analysis Type preference. Import 3D objects or 2D objects (objects must be in the x-y plane)

Type GeometryAnalysisType

Read Only No

InputMeshes

The list of all input meshes for the current model.

Type List<DataReference>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 403
Finite Element Modeler

Read Only Yes

UnitSystem

The Unit System name of the Assembly Mesh. This entity is displayed as a Property for the User to
modify.

Type String[]

Read Only No

FEMSetup
This output object is used for transferring various generated data: The Faceted representation of the
Geometry will be stored in an 'fedb' file whose reference can be retrieved using the 'FEModelerFile'
public property. The ANSYS Input file for the ANSYS solver will be stored in an 'inp' file whose reference
can be retrieved using the 'ANSYSInputFile' public property. The NURBS representation of the geometry
will be stored in an 'x_t' file whose reference can be retrieved using the 'ParasolidFile' public property.
The Materials used in the mesh will be stored in an XML file whose reference can be retrieved using
the 'FiniteElementModelMaterials' public property.

Properties
ANSYSInputFile

The reference of the 'inp' file representing the ANSYS input for the solver.

Type DataReference

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FEModelerFile

The reference of the 'fedb' file representing the Faceted Geometry.

Type DataReference

Read Only Yes

FiniteElementModelMaterials

The reference of the 'xml' file representing the Materials of the mesh.

Type DataReference

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
404 of ANSYS, Inc. and its subsidiaries and affiliates.
ParasolidFile

The reference of the 'x_t' file representing the NURBS Geometry.

Type DataReference

Read Only Yes

FEMUpstreamInputMesh
An input mesh object representing an upstream connection

Properties
BodyGrouping

The body grouping property of the input mesh (when importing it from a file). This entity is displayed
as a Property for the User to modify.

Type BodyGrouping

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FileFormat

The format of the mesh file. Even if the input type is an upstream connection, there is an associated
transfer file.

Type ModelType

Read Only Yes

FileReference

The file reference of the mesh file. Even if the input type is an upstream connection, there is an associated
tranfer file.

Type DataReference

Read Only Yes

IDHandling

The ID Handling property of the input mesh. This entity is displayed as a Property for the User to
modify.

Type IDHandling

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 405
Finite Element Modeler

Read Only No

UnitSystem

The Unit System of the input mesh (when importing it from a file). This entity is displayed as a Property
for the User to modify.

Type String[]

Read Only No

FEMUserInputMesh
An input mesh object rpresenting a Mesh File added by the User.

Properties
BodyGrouping

The body grouping property of the input mesh (when importing it from a file). This entity is displayed
as a Property for the User to modify.

Type BodyGrouping

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FileFormat

The format of the mesh file. Even if the input type is an upstream connection, there is an associated
transfer file.

Type ModelType

Read Only Yes

FileReference

The file reference of the mesh file. Even if the input type is an upstream connection, there is an associated
tranfer file.

Type DataReference

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
406 of ANSYS, Inc. and its subsidiaries and affiliates.
IDHandling

The ID Handling property of the input mesh. This entity is displayed as a Property for the User to
modify.

Type IDHandling

Read Only No

UnitSystem

The Unit System of the input mesh (when importing it from a file). This entity is displayed as a Property
for the User to modify.

Type String[]

Read Only No

Geometry
This entity represents the transfer of the Faceted representation of the Geometry, as well as its associated
Mesh, to a downstream system. This object is basically a wrapper for the MeshObject and SetupObject
data entities.

Properties
ACMOFile

The reference of the ACMO file representing the associated Mesh of the Faceted Geometry. This file is
ACMO-formatted.

Type DataReference

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FacetedGeometry

The reference of the Geometry file representing the associated Mesh of the Faceted Geometry. This file
is a .fedb format.

Type DataReference

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 407
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
408 of ANSYS, Inc. and its subsidiaries and affiliates.
FLUENT

FLUENT Setup
This container holds Setup data for an instance of FLUENT.

Methods
CopyLauncherSettings
Copies the FLUENT Launcher Settings from one FLUENT Setup or Solution container to another FLUENT
Setup or Solution container.

Edit
Opens the FLUENT editor to allow modification of FLUENT data.

This command will open the editor only if one is not already open on this system. If this system’s editor
is already open and in interactive mode, then it will be raised to the front.

Exit
Exits the FLUENT editor.

If no editor is open on the component in question, this command will have no effect.

GetFluentLauncherSettings
Returns the Data Entity which contains the Setup container's settings for the FLUENT Launcher.

Import
Imports the FLUENT mesh and FLUENT case settings into the FLUENT editor from an existing FLUENT
.msh or .cas file; replacing the current FLUENT mesh and FLUENT case settings. If the imported file
contains only a mesh, then the FLUENT case settings will be set to FLUENT's default values.

ImportRepositoryFile
Imports the FLUENT mesh/case file from EKM Repository

Required Arguments

File Reference to Case/Mesh file for Fluent

Type DataReference

FileType Reference to Fluent's File type

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 409
FLUENT

Type FileType

SendCommand
Execute a scheme, FLUENT GUI, or FLUENT TUI command(s) in the currently open FLUENT session.
FLUENT GUI commands cannot be run if the currently open FLUENT session is running in no GUI mode.

If the FLUENT editor is not open, it will be opened in no GUI mode before executing the command(s)
and then closed after the command(s) is executed.

Example
The following code shows how to execute the commands in a FLUENT journal file:

>> setup1.SendCommand(Command="/file/read-journal \"E:\\WB Projects\\Fluent Case-Data Files\elbow.jou\" " )

Data Entities
ChartVariable
Entity representing a variable in Convergence Chart

Properties
Color

Color of the curve represnting this variable entity.

Type Color

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

LineWidth

Line width of the curve represnting this variable entity.

Type float

Read Only No

QuantityName

The variable quantity to display.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
410 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

SymbolSize

Symbol size of the points on the curve.

Type uint

Read Only No

Methods
DeleteChartVariable

Deletes a specified chart variable.

ConvergenceChart
Entity to store a convergence chart information.

Properties
AxisX

Associated X Axis

Type DataReference

Read Only No

AxisY

Associated Y Axis

Type DataReference

Read Only No

ChartType

MonitorChartType: Residual or UserDefined

Type MonitorChartType

Read Only No

Variables

Collection of variables to be plotted.

Type DataReferenceSet

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 411
FLUENT

XAxis

Label for the x-axis/Horizontal Axis.

Type string

Read Only No

Methods
GetAxis

Returns the axis for a specified convergence chart

Return The axis

Type DataReference

Required Arguments

Name Name of the Axis

Type string

GetChartVariable

Returns the chart variable of a given name from a convergence chart

Return The chart variable that matches the specified name.

Type DataReference

Required Arguments

Name The name of the chart variable.

Type string

GetChartVariables

Returns the collection of chart variables for a given convergence chart

Return A collection of the variables in the chart.

Type DataReferenceSet

FluentLauncherSettings
Allows you to specify FLUENT Launcher settings for Fluent Setup/Solution cells.

Properties
CachePassword

Specify whether or not you want to save the HP-MPI password for later use.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
412 of ANSYS, Inc. and its subsidiaries and affiliates.
Type bool

Read Only No

ClusterHeadNode

Specify the name of the compute cluster head node.

This property is only available on Windows.

Type string

Read Only No

ClusterJobTemplate

A custom submission policy created by an IT administrator to define the job parameters for an application
and employed by the cluster users to submit jobs. Relevant for Microsoft Job Scheduler.

Type string

Read Only No

ClusterNodeGroup

Used to set specific node group(s) on which to run the job. Relevant for Microsoft Job Scheduler.

Type string

Read Only No

ClusterProcessorUnit

Select the unit type (node/socket/core) on which the job would be running. Relevant for Microsoft Job
Scheduler.

Type ProcessorUnit

Read Only No

ConvertUNCPath

Specify whether or not to convert a local path to a UNC path if any matching shared directory is found.

Type bool

Read Only No

CreateJobSubmissionXML

Specify whether or not to create the job submission XML file.

This property is only available on Windows.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 413
FLUENT

Read Only No

DisplayMesh

Specify whether or not to show the mesh after the mesh file or the case/data file has been read into
FLUENT.

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

EmbedGraphicsWindows

Specify whether or not to embed the graphics windows in the FLUENT application window, or to have
the graphics windows free-standing.

Type bool

Read Only No

EnvPath

Specify the list of environment variables to set before starting FLUENT.

Type Dictionary<string, string>

Read Only No

Initialization

Specify which initialization method to use.

Type InitializationMethods

Read Only No

InitSolutionDataFile

Spepcify the solution data file to be used for initializing the solution.

Type string

Read Only No

Interconnect

Specify the interconnect that you wish to use for parallel calculations

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
414 of ANSYS, Inc. and its subsidiaries and affiliates.
(e.g., ethernet, myrinet, infniband, etc.).

Type string

Read Only No

JobScheduler

Use available Resource Manager (LSF, SGE, PBSPro) to launch FLUENT job

This property is only available when using compute nodes on Linux.

Type SchedulerSpecification

Read Only No

JobSubmissionXmlFile

Specify the name of the job submission XML file.

This property is only available on Windows.

Type string

Read Only No

LSFCheckpointPeriod

Specify the interval of automatic checkpointing for LSF.

This property is only available when using compute nodes on Linux.

Type int

Read Only No

LSFQueue

Specify the name of the LSF queue.

This property is only available when using compute nodes on Linux.

Type string

Read Only No

LSFUseAutomaticCheckpointing

Specify whether or not you want to use automatic checkpointing with LSF. The specific interval for
checkpointing is determined by the LSFCheckpointPeriod property.

This property is only available when using compute nodes on Linux.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 415
FLUENT

MachineFileName

Specify the name of the file that contains a list of machine names to run the parallel job.

Type string

Read Only No

MachineList

Specify a list of machine names to run the parallel job.

Type string

Read Only No

MachineSpec

Specify a list of machine names, or a file that contains machine names.

Type MachineSpecification

Read Only No

MpiType

Specify the MPI type that you wish to use for the parallel calculations

(e.g., MPICH2, HP, etc.).

Type string

Read Only No

NumberOfProcessors

Specify the number of processors you wish to use for the parallel calculations (e.g., 2, 4, etc.).

Type int

Read Only No

NumberOfProcessorsMeshing

Specify the number of processors you wish to use for the meshing parallel calculations (e.g., 2, 4, etc.).

Type int

Read Only No

Precision

Specify whether to use the single-precision or the double-precision solver.

Type CasePrecision

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
416 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

PrePostOnly

Specify whether or not you want to run FLUENT in PrePost mode, which only allows you to set up or
postprocess a problem (i.e., no calculations can be performed)

Type bool

Read Only No

RemoteFluentRootPath

Specify the root path of the remote FLUENT Linux installation.

This property is only available on Windows.

Type string

Read Only No

RemoteHostName

Specify the name of the head machine on the remote Linux cluster.

This property is only available on Windows.

Type string

Read Only No

RemoteRshCommand

Specify the command to connect to the remote node (the default is RSH).

This property is only available on Windows.

Type RshSpecification

Read Only No

RemoteRshOtherCommand

Specify the custom RSH spawn command used to connect to the remote Linux machine.

This property is only available on Windows.

Type string

Read Only No

RemoteRunOnLinux

Specify whether or not you want to run your FLUENT simulation on 64-bit Linux machines.

This property is only available on Windows.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 417
FLUENT

Type bool

Read Only No

RemoteUseHost

Specify whether or not to use the remote cluster head node that FLUENT will connect to for spawning
(e.g., via rsh or ssh).

Use the RemoteHostName property to specify the name of the remote cluster head node.

This property is only available on Windows.

Type bool

Read Only No

RemoteUseWorkingDirectory

Specify whether or not to use a working directory for remote Linux nodes.

Use the RemoteWorkingDirectory property to specify the name of the working directory.

This property is only available on Windows.

Type bool

Read Only No

RemoteWorkingDirectory

Specify the name of the working directory for remote Linux nodes.

This property is only available on Windows.

Type string

Read Only No

RunParallel

Specify whether or not you want to run the parallel version of FLUENT.

Type bool

Read Only No

SetupCompilationEnvironment

Specify whether or not you want to define settings for compiling user-defined functions (UDFs) with
FLUENT.

This property is only available on Windows.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
418 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

SGEPE

Specify the SGE parallel environment where you want to submit your FLUENT jobs.

This property is only available when using compute nodes on Linux.

Type string

Read Only No

SGEQMaster

Specify the name of the Qmaster host.

This property is only available when using compute nodes on Linux.

Type string

Read Only No

SGEQueue

Specify the name of the queue where you want to submit your FLUENT jobs.

This property is only available when using compute nodes on Linux.

Type string

Read Only No

SGESettings

Specify SGE Settings to be used

This property is only available when using compute nodes on Linux.

Type string

Read Only No

SGEUseSettings

Specify whether or not to use the specified SGE Settings.

Use the SGESettings property to specify the SGE Settings.

This property is only available when using compute nodes on Linux.

Type bool

Read Only No

ShowLauncher

Specify whether or not to show FLUENT Launcher when FLUENT starts.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 419
FLUENT

Type bool

Read Only No

StartWhenResourcesAvailable

Specify whether or not to start the FLUENT job when resources are available.

This property is only available on Windows.

Type bool

Read Only No

UDFPath

Specify the path to the UDF compilation script (available when SetupCompilationEnvironment is TRUE).

This property is only available on Windows.

Type string

Read Only No

UseJobScheduler

Specify whether or not to use a job scheduler to run FLUENT jobs.

Type bool

Read Only No

UseLSFCheckpoint

Specify whether or not to use LSF checkpointing.

This property is only available when using compute nodes on Linux.

Type bool

Read Only No

UseLSFQueue

Specify whether or not to use the LSF queue.

This property is only available when using compute nodes on Linux.

Type bool

Read Only No

UseSharedMemory

Specify whether or not to use shared memory on the local machine or to use distributed memory on
a cluster.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
420 of ANSYS, Inc. and its subsidiaries and affiliates.
Type bool

Read Only No

UseUpstreamLauncherSettings

Specify whether or not the current system's Solution cell should use FLUENT Launcher's property settings
from the current system's Setup cell.

Type bool

Read Only No

WorkbenchColorScheme

Specify whether or not to use the Workbench color scheme in the graphics window, or the classic black
background color.

Type bool

Read Only No

SetupData
Data entity of Setup cell. Allows you to change attributes of Setup cell.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

GenerateSetupOutput

Allows you to generate case file for Setup cell if mesh file is input or mesh operations are defined

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 421
FLUENT

FLUENT Solution
This container holds Solution data for an instance of FLUENT.

Methods
Continue
Continue solving from current solution. This command should only be used when the Solution component
is either Interrupted or Up-to-Date.

CopyLauncherSettings
Copies the FLUENT Launcher Settings from one FLUENT Setup or Solution container to another FLUENT
Setup or Solution container.

Edit
Opens the FLUENT editor to allow modification of FLUENT data.

This command will open the editor only if one is not already open on this system. If this system’s editor
is already open and in interactive mode, then it will be raised to the front.

Exit
Exits the FLUENT editor.

If no editor is open on the component in question, this command will have no effect.

GetComponentSettingsForRsmDpUpdate
This query is used to obtain the ComponentSettingsForRsmDpUpdate object for Journaling and
Scripting

GetConvergenceChart
Returns the convergence chart of a given name in a container.

Return The convergence chart that matches the specified name.

Type DataReference

Required Arguments

Name The name of the convergence chart.

Type string

GetConvergenceCharts
Returns the collection of convergence charts in a container. If no convergence charts are in the container,
the collection is empty.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
422 of ANSYS, Inc. and its subsidiaries and affiliates.
Return Collection of the convergence charts in the container.

Type DataReferenceSet

GetFluentLauncherSettings
Returns the Data Entity which contains the Setup container's settings for the FLUENT Launcher.

GetFluentSolutionProperties
Returns the Data Entity which manages settings and data for the FLUENT Solution component.

GetSolutionSettings
This query is used to obtain the solution settings object for Journaling and Scripting

ImportInitialData
Imports an existing FLUENT .dat file as initial conditions for the FLUENT editor.

Discards the currently available Solution Data (and all stored previous solution points).

ImportRepositoryFinalData
Command to import final data file from repository

Required Arguments

File Reference to Fluent data file

Type DataReference

MarkUpToDate
Accepts an interrupted Solution as Up-to-Date.

The specified Solution component should be in Interrupted state. As a result of this command, the
Solution will be marked Up-to-date.

SendCommand
Execute a scheme, FLUENT GUI, or FLUENT TUI command(s) in the currently open FLUENT session.
FLUENT GUI commands cannot be run if the currently open FLUENT session is running in no GUI mode.

If the FLUENT editor is not open, it will be opened in no GUI mode before executing the command(s)
and then closed after the command(s) is executed.

Example
The following code shows how to execute the commands in a FLUENT journal file:

>> setup1.SendCommand(Command="/file/read-journal \"E:\\WB Projects\\Fluent Case-Data Files\elbow.jou\" " )

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 423
FLUENT

Data Entities
AxisContinuous
Data entity for Scenegraph axis.

Properties
AutomaticRange

Boolean var for Automatic Range

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

QuantityName

Name of the quantity being plotted at this axis

Type XAxisQuantity

Read Only No

RangeMaximum

Max value of quantity at this axis

Type double

Read Only No

RangeMinimum

Min value of quantity at this axis

Type double

Read Only No

Scale

Scale of this axis

Type Scale

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
424 of ANSYS, Inc. and its subsidiaries and affiliates.
Title

Title of the axis

Type string

Read Only No

ChartVariable
Entity representing a variable in Convergence Chart

Properties
Color

Color of the curve represnting this variable entity.

Type Color

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

LineWidth

Line width of the curve represnting this variable entity.

Type float

Read Only No

QuantityName

The variable quantity to display.

Type string

Read Only No

SymbolSize

Symbol size of the points on the curve.

Type uint

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 425
FLUENT

Methods
DeleteChartVariable

Deletes a specified chart variable.

ChartVariableData
Entity representing a variable in Convergence Chart

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

VariableDimension

Dimentions in string format

Type string

Read Only No

VariableIndex

A integer: variable index of given MonitorChartType

Type int

Read Only No

VariableType

MonitorChartType: Residual or UserDefined, an enum

Type MonitorChartType

Read Only No

ConvergenceChart
Entity to store a convergence chart information.

Properties
AxisX

Associated X Axis

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
426 of ANSYS, Inc. and its subsidiaries and affiliates.
Type DataReference

Read Only No

AxisY

Associated Y Axis

Type DataReference

Read Only No

ChartType

MonitorChartType: Residual or UserDefined

Type MonitorChartType

Read Only No

Variables

Collection of variables to be plotted.

Type DataReferenceSet

Read Only No

XAxis

Label for the x-axis/Horizontal Axis.

Type string

Read Only No

Methods
GetAxis

Returns the axis for a specified convergence chart

Return The axis

Type DataReference

Required Arguments

Name Name of the Axis

Type string

GetChartVariable

Returns the chart variable of a given name from a convergence chart

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 427
FLUENT

Return The chart variable that matches the specified name.

Type DataReference

Required Arguments

Name The name of the chart variable.

Type string

GetChartVariables

Returns the collection of chart variables for a given convergence chart

Return A collection of the variables in the chart.

Type DataReferenceSet

FluentLauncherSettings
Allows you to specify FLUENT Launcher settings for Fluent Setup/Solution cells.

Properties
CachePassword

Specify whether or not you want to save the HP-MPI password for later use.

Type bool

Read Only No

ClusterHeadNode

Specify the name of the compute cluster head node.

This property is only available on Windows.

Type string

Read Only No

ClusterJobTemplate

A custom submission policy created by an IT administrator to define the job parameters for an application
and employed by the cluster users to submit jobs. Relevant for Microsoft Job Scheduler.

Type string

Read Only No

ClusterNodeGroup

Used to set specific node group(s) on which to run the job. Relevant for Microsoft Job Scheduler.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
428 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

ClusterProcessorUnit

Select the unit type (node/socket/core) on which the job would be running. Relevant for Microsoft Job
Scheduler.

Type ProcessorUnit

Read Only No

ConvertUNCPath

Specify whether or not to convert a local path to a UNC path if any matching shared directory is found.

Type bool

Read Only No

CreateJobSubmissionXML

Specify whether or not to create the job submission XML file.

This property is only available on Windows.

Type bool

Read Only No

DisplayMesh

Specify whether or not to show the mesh after the mesh file or the case/data file has been read into
FLUENT.

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

EmbedGraphicsWindows

Specify whether or not to embed the graphics windows in the FLUENT application window, or to have
the graphics windows free-standing.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 429
FLUENT

EnvPath

Specify the list of environment variables to set before starting FLUENT.

Type Dictionary<string, string>

Read Only No

Initialization

Specify which initialization method to use.

Type InitializationMethods

Read Only No

InitSolutionDataFile

Spepcify the solution data file to be used for initializing the solution.

Type string

Read Only No

Interconnect

Specify the interconnect that you wish to use for parallel calculations

(e.g., ethernet, myrinet, infniband, etc.).

Type string

Read Only No

JobScheduler

Use available Resource Manager (LSF, SGE, PBSPro) to launch FLUENT job

This property is only available when using compute nodes on Linux.

Type SchedulerSpecification

Read Only No

JobSubmissionXmlFile

Specify the name of the job submission XML file.

This property is only available on Windows.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
430 of ANSYS, Inc. and its subsidiaries and affiliates.
LSFCheckpointPeriod

Specify the interval of automatic checkpointing for LSF.

This property is only available when using compute nodes on Linux.

Type int

Read Only No

LSFQueue

Specify the name of the LSF queue.

This property is only available when using compute nodes on Linux.

Type string

Read Only No

LSFUseAutomaticCheckpointing

Specify whether or not you want to use automatic checkpointing with LSF. The specific interval for
checkpointing is determined by the LSFCheckpointPeriod property.

This property is only available when using compute nodes on Linux.

Type bool

Read Only No

MachineFileName

Specify the name of the file that contains a list of machine names to run the parallel job.

Type string

Read Only No

MachineList

Specify a list of machine names to run the parallel job.

Type string

Read Only No

MachineSpec

Specify a list of machine names, or a file that contains machine names.

Type MachineSpecification

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 431
FLUENT

MpiType

Specify the MPI type that you wish to use for the parallel calculations

(e.g., MPICH2, HP, etc.).

Type string

Read Only No

NumberOfProcessors

Specify the number of processors you wish to use for the parallel calculations (e.g., 2, 4, etc.).

Type int

Read Only No

NumberOfProcessorsMeshing

Specify the number of processors you wish to use for the meshing parallel calculations (e.g., 2, 4, etc.).

Type int

Read Only No

Precision

Specify whether to use the single-precision or the double-precision solver.

Type CasePrecision

Read Only No

PrePostOnly

Specify whether or not you want to run FLUENT in PrePost mode, which only allows you to set up or
postprocess a problem (i.e., no calculations can be performed)

Type bool

Read Only No

RemoteFluentRootPath

Specify the root path of the remote FLUENT Linux installation.

This property is only available on Windows.

Type string

Read Only No

RemoteHostName

Specify the name of the head machine on the remote Linux cluster.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
432 of ANSYS, Inc. and its subsidiaries and affiliates.
This property is only available on Windows.

Type string

Read Only No

RemoteRshCommand

Specify the command to connect to the remote node (the default is RSH).

This property is only available on Windows.

Type RshSpecification

Read Only No

RemoteRshOtherCommand

Specify the custom RSH spawn command used to connect to the remote Linux machine.

This property is only available on Windows.

Type string

Read Only No

RemoteRunOnLinux

Specify whether or not you want to run your FLUENT simulation on 64-bit Linux machines.

This property is only available on Windows.

Type bool

Read Only No

RemoteUseHost

Specify whether or not to use the remote cluster head node that FLUENT will connect to for spawning
(e.g., via rsh or ssh).

Use the RemoteHostName property to specify the name of the remote cluster head node.

This property is only available on Windows.

Type bool

Read Only No

RemoteUseWorkingDirectory

Specify whether or not to use a working directory for remote Linux nodes.

Use the RemoteWorkingDirectory property to specify the name of the working directory.

This property is only available on Windows.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 433
FLUENT

Type bool

Read Only No

RemoteWorkingDirectory

Specify the name of the working directory for remote Linux nodes.

This property is only available on Windows.

Type string

Read Only No

RunParallel

Specify whether or not you want to run the parallel version of FLUENT.

Type bool

Read Only No

SetupCompilationEnvironment

Specify whether or not you want to define settings for compiling user-defined functions (UDFs) with
FLUENT.

This property is only available on Windows.

Type bool

Read Only No

SGEPE

Specify the SGE parallel environment where you want to submit your FLUENT jobs.

This property is only available when using compute nodes on Linux.

Type string

Read Only No

SGEQMaster

Specify the name of the Qmaster host.

This property is only available when using compute nodes on Linux.

Type string

Read Only No

SGEQueue

Specify the name of the queue where you want to submit your FLUENT jobs.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
434 of ANSYS, Inc. and its subsidiaries and affiliates.
This property is only available when using compute nodes on Linux.

Type string

Read Only No

SGESettings

Specify SGE Settings to be used

This property is only available when using compute nodes on Linux.

Type string

Read Only No

SGEUseSettings

Specify whether or not to use the specified SGE Settings.

Use the SGESettings property to specify the SGE Settings.

This property is only available when using compute nodes on Linux.

Type bool

Read Only No

ShowLauncher

Specify whether or not to show FLUENT Launcher when FLUENT starts.

Type bool

Read Only No

StartWhenResourcesAvailable

Specify whether or not to start the FLUENT job when resources are available.

This property is only available on Windows.

Type bool

Read Only No

UDFPath

Specify the path to the UDF compilation script (available when SetupCompilationEnvironment is TRUE).

This property is only available on Windows.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 435
FLUENT

UseJobScheduler

Specify whether or not to use a job scheduler to run FLUENT jobs.

Type bool

Read Only No

UseLSFCheckpoint

Specify whether or not to use LSF checkpointing.

This property is only available when using compute nodes on Linux.

Type bool

Read Only No

UseLSFQueue

Specify whether or not to use the LSF queue.

This property is only available when using compute nodes on Linux.

Type bool

Read Only No

UseSharedMemory

Specify whether or not to use shared memory on the local machine or to use distributed memory on
a cluster.

Type bool

Read Only No

UseUpstreamLauncherSettings

Specify whether or not the current system's Solution cell should use FLUENT Launcher's property settings
from the current system's Setup cell.

Type bool

Read Only No

WorkbenchColorScheme

Specify whether or not to use the Workbench color scheme in the graphics window, or the classic black
background color.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
436 of ANSYS, Inc. and its subsidiaries and affiliates.
FluentSolutionProperties
Entity that manages settings and data for the FLUENT Solution component.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

EnableDataInterpolation

It allows to generate the interpolation file at the end of calculation. It can be used as inial data for next
calculation even if inout mesh data has changed.

Type bool

Read Only No

EnableSolutionMonitoring

It allows to generate the solution monitoring data which can be viewed using commands at Solution
cell.

Type bool

Read Only No

FLUENT TGridData
This container holds TGrid data for an instance of FLUENT.

Data Entities
TGridCADImportOptions
Entity represents CAD import properties from upstream geometry to Fluent Meshing cell

Properties
CT_EdgeProximity

Enables the use of the edge proximity size function for creating the conformal tessellation, based on
the number of cells per gap specified.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 437
FLUENT

CT_SaveSizeField

Enables user to save the size field in a file, which is computed based on the defined parameters i.e. Min
Size, Max Size, Curvature Normal Angle, Cells Per Gap.

Type bool

Read Only No

CT_SizeFieldFileLoc

Specifies the location of the size field file to save.

Type string

Read Only No

CT_SizeFieldFileName

Specifies the file name for the size field file.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FeatureAngle

Allows user to specify the feature angle to determine the features to be imported. The default value is
40.

Type double

Read Only No

TessellationOption

Options that allow user to control the tessellation (faceting)

Type string

Read Only No

Units

Specifies the length unit to scale the mesh on import. Models created in other units will be scaled ac-
cordingly. The default is meters (m).

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
438 of ANSYS, Inc. and its subsidiaries and affiliates.
Type string

Read Only No

TGridData
Data entity of Fluent Meshing cell. Allows you to change attributes of Fluent Meshing cell.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

RunParallel

Specify whether or not you want to run the parallel version of FLUENT.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 439
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
440 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

Geometry
This container holds imported or generated geometry from an instance of DesignModeler.

Methods
Edit
The Edit command starts DesignModeler session, if it is not already running. If DesignModeler session
is already running, this command brings the DesignModeler window in focus.

If a CAD file is assigned to geometry component, the file is loaded in the DesignModeler.

Available options:

Interactive This optional boolean type argument indicates

whether DesignModeler is to be started in In-
teractive mode or batch mode. Its default
value is True

Optional Arguments

Interactive Whether to edit in batch mode

Type bool

Default Value True

IsSpaceClaimGeometry Whether to edit geometry in SpaceClaim. If the user wants to use SpaceClaim
as the geometry editor, then IsSpaceClaimGeometry should be set to true. The
default value of IsSpaceClaimGeometry is false. If the user edits the geometry
using DesignModeler then "IsSpaceClaimGeometry" will be false.

Type bool

Default Value False

Exit
Exit command shuts down the running session of DesignModeler. Before shuting down, DesignModeler
generates the un-generated features and saves its database.

DesignModeler session can not be closed if it is busy in generating features or seeking user's input. In
such situations, this command throws an ApplicationBusyException exception.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 441
Geometry

Export
The export command exports geometry data in DesignModeler to the location specified in its FilePath
argument. The export file CAD format is dedcued from the extension of FilePath.

Available options:

FilePath This argument points to the location where

the exported file should be saved. The file-
name extension specifies the export file format

The command throws following exception

CommandFailedException export file format is not supportedExport file

location doesn't existsFile name contains inval-
id characters
ApplicationBusyException When DesignModeler is busy.

Required Arguments

FilePath Output file path

Type string

Example
Suppose the geometry in the container "Geometry" needs to exported to IGES and STEP formats. This can
be achieved by the following example.

geometry1 = GetDataContainer("Geometry")
geometry1.Export(FilePath="C:/Models/geometry1.iges")
geometry1.Export(FilePath=AbsUserPathName("Models/geometry1.step"))

GetGeometryProperties
Return a reference to DataEntity managing property settings of geometry container.

Return Reference to DataEntity managing geometry properties

Type DataReference

Refresh
Refresh command refreshes the input data in a geometry component by consuming all changed data
from upstream (source) components. This command also updates the modified parameters in Design-
Modeler.

After succesful execution of this command, the geometry component goes into "update required" state.

Optional Arguments

RepositoryFilesToRefresh Registered Repository files

Type List<DataReference>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
442 of ANSYS, Inc. and its subsidiaries and affiliates.
SendCommand
The SendCommand sends javascript or python command string to DesignModeler for execution. If
DesignModeler is not open, it will be launched to execute commands, and then closed. If DesignModeler
is already running, it will keep running after the command execution.

If DesignModeler is busy and not available for executing the instruction, the SendCommand throws an
ApplicationBusyException exception.

Available options:

Command Javascript or Python command string contain-

ing scripting commands for DesignModeler
Language Language of the command. Allowed values
are: "Javascript" and "Python". The default
language is "Javascript"

The following command will add a sketch with an elliptical curve in DesignModeler

Required Arguments

Com- Command string

mand
Type string

Optional Arguments

Language Language of the command. The default value of Language is "Javascript".

Type string

Default Value Javascript

Example

system1 = GetSystem(Name="Geom")
geometry1 = system1.GetContainer(ComponentName="Geometry")
geometry1.SendCommand( Command = """var ps1 = new Object();
ps1.Plane = agb.GetActivePlane();
ps1.Origin = ps1.Plane.GetOrigin();
ps1.XAxis = ps1.Plane.GetXAxis();
ps1.YAxis = ps1.Plane.GetYAxis();
ps1.Sk1 = ps1.Plane.NewSketch();
ps1.Sk1.Name = "Sketch1";
with (ps1.Sk1) { ps1.El7 = Ellipse( 8.0, 10.0, 9.0, 6.0, 5.0, 12.0); }
agb.Regen();""")

SetFile
Adds a Geometry file to the Geometry System. The file processed by DesignModeler

Available options:

FilePath Path of the geometry file

PlugInName PlugIn Name, in case of PlugIn mode geo-
metry transfer

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 443
Geometry

Required Arguments

FilePath Path of the Geometry File

Type string

Optional Arguments

CreatedFileRef Created File reference

Type Output<DataReference>

PlugInName PlugIn Name, in case of PlugIn mode Geometry transfer

Type string

RepositoryFileReference Reference for the Geometry file if from repository

Type DataReference

Example

geometry1 = GetDataContainer("Geometry")
geometry1.SetFile("C:/Models/block.iges")
geometry2 = GetDataContainer("Geometry 1")
geometry2.SetFile(FilePath=AbsUserPathName("Models/block.prt.1"), PlugInName="ProEngineer[1]")

Stop
Stop command shuts down the running session of DesignModeler immeditely, without saving its unsaved
data.

The DesignModeler session can not be stopped if it is busy in importing or exporting CAD files. In such
situations, this command throws an ApplicationBusyException exception.

UpdateCAD
The UpdateCAD command updates geometry component using parameter values from DesignModeler.
If the parameters are coming from external CAD systems through attach features in DesignModeler,
then the attach feature is refreshed to update the parameters. The DesignModeler model is re-generated
using the updated parameter values.

UpdateICManagerParam
Update IC Manager Param updates any of the exposed ICManager parameters

Required Arguments

QuantityName Name of the Quantity To Update

Type string

QuantityValue Double value of the Quantity to update

Type double

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
444 of ANSYS, Inc. and its subsidiaries and affiliates.
Data Entities
Geometry
Geometry data object

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

GeometryFilePath

The location of file currently assigned to geometry component. DesignModeler process this file when
started through Edit command.

Type string

Read Only No

GeometryImportAnalysisType

Analysis Type preference. Import 3D objects or 2D objects (objects must be in the x-y plane)

Type AnalysisType

Read Only No

GeometryImportCadAssociativity

Associativity preference. Indicates if action should be taken to allow associativity. This option is present
because some CAD systems take too long to compute associativity.

Type bool

Read Only No

GeometryImportCadAttributes

Import Attributes preference. Allows import of CAD system attributes into the Mechanical application
models. Enable this option to import Motion Loads.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 445
Geometry

GeometryImportCadAttributesFilter

Import Attributes filter Key. (Displayed only when Attributes is selected.) This field can have any number
of prefixes with each prefix delimited by a semicolon. If the filter is set to an empty string all applicable
entities will be imported as Attributes.

Type string

Read Only No

GeometryImportComparePartsOnUpdate

Compare Parts On Update preference. Runs a post update comparison of parts from the original model
and the new one. Marking those which have no topological or geometric changes as unmodified. This
marking saves the time for remeshing.

Type ComparePartsOnUpdateMethod

Read Only No

GeometryImportComparePartsTolerance

Compare Parts Tolerance Preference. Sets one of three tolerance values for comparison when running
Compare Parts On Update

Type ComparePartsTolerance

Read Only No

GeometryImportCoordinateSystems

Import Coordinate Systems preference. Specifies whether coordinate systems created in the CAD applic-
ation should be imported into the Mechanical application.

Type bool

Read Only No

GeometryImportDecomposeDisjointFaces

Decompose Disjoint Face preference. Use to turn on/off the breaking of disjoint faces into multiple
faces.

Type bool

Read Only No

GeometryImportFlattenAssembly

Import Flattened Assembly Preference // hidden

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
446 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryImportImportUsingInstances

Import Using Instances preference. Processes a CAD model by honoring its part instances to produce
faster attach times and smaller database sizes.

Type bool

Read Only No

GeometryImportLineBodies

Import Line Bodies preference. (If mixed dimension parts, Mixed Import Resolution preference is used.)

Type bool

Read Only No

GeometryImportMaterialProperties

Import Material Properties preference. Allows import of material data defined in the CAD system. Only
a subset of material data will be imported. This will include Young's Modulus, Poisson Ratio, Mass
Density, Specific Heat, Thermal Conductivity and Thermal Expansion Coefficient. Limited additional data
may be imported depending on CAD support.

Type bool

Read Only No

GeometryImportMixedResolutionOption

Mixed Import Resolution preference. Allows parts of mixed dimension to be imported as components
of assemblies which have parts of different dimension.

Type MixedImportPref

Read Only No

GeometryImportNamedSelections

Import Named Selections preference. Creates a named selection based on data generated in the CAD
system or in the DesignModeler application.

Type bool

Read Only No

GeometryImportNamedSelectionsFilter

Import Named Selections filter Key. (Displayed only when Named Selections is selected.) This field can
have any number of prefixes with each prefix delimited by a semicolon. If the filter is set to an empty
string all applicable entities will be imported as Named Selections.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 447
Geometry

GeometryImportParameters

Import Parameters preference. Allows user to turn on or off parameter processing.

Type bool

Read Only No

GeometryImportParametersFilter

Import Parameter filter Key. (Displayed only when Parameters is selected.) Allows user to specify a key
that must appear at the beginning or end of a CAD parameter name to be imported. If the filter is set
to an empty string all CAD parameters will be imported.

Type string

Read Only No

GeometryImportProcessEnclosures

Enclosure and Symmetry preference. Use to turn on/off the processing of enclosure and symmetry
named selections.

Type bool

Read Only No

GeometryImportSavePartFile

Reader Mode Saves Updated File preference. When set to Yes, the interface will save the part file of a
model at the end of an update process using the same file name in the same directory.

Type bool

Read Only No

GeometryImportSmartUpdate

Smart CAD Update preference. Speeds up refresh of models that have unmodified components. If set
to Yes and changes are made to other preferences, these will not be respected if the component is
smart updated.

Type bool

Read Only No

GeometryImportSolidBodies

Import Solid Bodies preference. (If mixed dimension parts, Mixed Import Resolution preference is used.)

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
448 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryImportSpaceClaimExplodeUnsharedComponents

GeometryImportSpaceClaimExplodeUnsharedComponents

Type bool

Read Only No

GeometryImportSTLAngleAlgorithmCutAngle

Cut Angle parameter for the Angle Algorithm

Type double

Read Only No

GeometryImportSTLAngleAlgorithmToleranceAngle

Tolerance Angle parameter for the Angle Algorithm

Type double

Read Only No

GeometryImportSTLCurvatureAlgorithmIgnoreSecondaryNodes

Ignore secondary nodes parameter for the Curvature Algorithm

Type bool

Read Only No

GeometryImportSTLCurvatureAlgorithmPlanesToleranceAngle

Planes tolerance parameter for the Curvature Algorithm

Type double

Read Only No

GeometryImportSTLCurvatureAlgorithmSharpEdgesAngle

Sharp edges angle parameter for the Curvature Algorithm

Type double

Read Only No

GeometryImportSTLSDTAlgorithm

Analysis Type preference. Import 3D objects or 2D objects (objects must be in the x-y plane)

Type STLSDTAlgorithm

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 449
Geometry

GeometryImportSurfaceBodies

Import Surface Bodies preference. (If mixed dimension parts, Mixed Import Resolution preference is
used.)

Type bool

Read Only No

GeometryImportWeightclass

Import Weightclass option

Type ImportWeightclass

Read Only No

GeometryImportWorkPoints

Import Work Points preference. Specifies whether work points created in the CAD application should
be imported into the Mechanical application.

Type bool

Read Only No

PlugInName

Current PlugInName - Returns TempPlugin if active DM session is editing. Otherwise return the real
plugin name. This is also not persisted.

Type string

Read Only No

TeamcenterConnection

The source string obtained from the Teamcenter, pointing to the NX geometry.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
450 of ANSYS, Inc. and its subsidiaries and affiliates.
Graphics

Graphics
This container holds charts and graphics objects in the project.

Data Entities
AxisContinuous
A chart axis that spans a set of continuous values. An example is an axis of an XY plot.

Properties
AutoScale

This property will define whether or not automatic scaling should be applied to the axis, or whether
the RangeMin and RangeMax should be used.

Type bool

Read Only No

Label

The label of the axis.

Type string

Read Only No

Logarithmic

This property controls whether the axis scaling is to be logarithmic or linear. The default is linear scaling.

Type bool

Read Only No

RangeMax

The maximum range of the values in this axis.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 451
Graphics

RangeMin

The minimum range of the values in this axis.

Type double

Read Only No

ShowGrid

Defines whether or not to show a grid for this chart axis.

Type bool

Read Only No

TitleBackgroundColor

This defines the background color of an axis title. This is particularly useful when you want to be able
to identify which variable is associated with which axis. The default is transparent.

Type Color

Read Only No

Usability

Determine whether this axis represents a usability axis. A usability axis presents discrete allowable values
rather than continuous values.

Type bool

Read Only No

AxisDiscrete
A chart axis that represents a set of discrete values. An example is an axis of a bar chart.

Properties
AutoScale

This property will define whether or not automatic scaling should be applied to the axis, or whether
the RangeMin and RangeMax should be used.

Type bool

Read Only No

Label

The label of the axis.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
452 of ANSYS, Inc. and its subsidiaries and affiliates.
RangeMax

The index of the last division of the discrete data to be used. If this is -1 then it is undefined and will
be determined dependent on the data.

Type uint

Read Only No

RangeMin

The index of the first division of the discrete data to be used. If this is -1 then it is undefined and will
be determined dependent on the data.

Type uint

Read Only No

ShowGrid

Defines whether or not to show a grid for this chart axis.

Type bool

Read Only No

TitleBackgroundColor

This defines the background color of an axis title. This is particularly useful when you want to be able
to identify which variable is associated with which axis. The default is transparent.

Type Color

Read Only No

ChartXY
This entity provides general properties for an XY (i.e. two dimensional) chart. Plotting details are determ-
ined from the associated variables and axes.

Properties
Legend

Reference to the Legend entity that is applied to the chart.

Type DataReference

Read Only No

Style

Reference to the RenderStyle entity that is applied to the chart.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 453
Graphics

Read Only No

Title

The title of the chart.

Type string

Read Only No

Variables

The variables to be displayed in this chart. This can be a list of Variable, VariableXY or VariableXYZ data
entities.

Type List<DataReference>

Read Only No

XAxis

The data reference to the x-axis.

Type DataReference

Read Only No

XAxisSecondary

The data reference to the secondary x-axis.

Type DataReference

Read Only No

YAxis

The data reference to the y-axis.

Type DataReference

Read Only No

YAxisSecondary

The data reference to the secondary y-axis.

Type DataReference

Read Only No

ChartXYZ
This chart is a canvas for an XYZ plot, the manor of plotting will be determined by the specified variables.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
454 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Legend

Reference to the Legend entity that is applied to the chart.

Type DataReference

Read Only No

Style

Reference to the RenderStyle entity that is applied to the chart.

Type DataReference

Read Only No

Title

The title of the chart.

Type string

Read Only No

Variables

The variables to be displayed in this chart. This can be a list of Variable, VariableXY or VariableXYZ data
entities.

Type List<DataReference>

Read Only No

XAxis

The data reference to the X-Axis.

Type DataReference

Read Only No

YAxis

The data reference to the Y-Axis.

Type DataReference

Read Only No

ZAxis

The data reference to the Y-Axis.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 455
Graphics

Read Only No

CorrelationMatrix
A Correlation Matrix uses a tabular graphic to display the strength of the relationships between multiple
parameters in a study.

Properties
CorrelationRange

This range defines the values and the distribution of correlation values to be applied to the color range.
This defaults from -1 to 1.

Type List<float>

Read Only No

Legend

Reference to the Legend entity that is applied to the chart.

Type DataReference

Read Only No

Style

Reference to the RenderStyle entity that is applied to the chart.

Type DataReference

Read Only No

Title

The title of the chart.

Type string

Read Only No

Variables

The variables to be displayed in this chart. This can be a list of Variable, VariableXY or VariableXYZ data
entities.

Type List<DataReference>

Read Only No

Legend
This entity provides a legend for chart data.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
456 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
BackgroundColor

The background color of the legend.

Type Color

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Enabled

This property will enable or disable the legend.

Type bool

Read Only No

ForegroundColor

The foreground (border) color of the legend.

Type Color

Read Only No

Orientation

This property defines the orientation of the legend.

Type OrientationStyle

Read Only No

MultiAxisChart
Specialization of a chart to represent a parallel coordinate plot or a spider chart. Multi-axis charts use
an independent axis for each supplied variable.

Properties
ChartType

Sets the type of rendering (e.g. Parallel Coordinate Plot, Spider Plot) for this multi-axis chart.

Type ChartStyle

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 457
Graphics

Read Only No

Legend

Reference to the Legend entity that is applied to the chart.

Type DataReference

Read Only No

Style

Reference to the RenderStyle entity that is applied to the chart.

Type DataReference

Read Only No

Title

The title of the chart.

Type string

Read Only No

Variables

The variables to be displayed in this chart. This can be a list of Variable, VariableXY or VariableXYZ data
entities.

Type List<DataReference>

Read Only No

PieChart
Pie chart data object that allows us to represent a displayable pie chart.

Properties
DivisionLabels

In a multi-axis chart we are plotting each variable as an axis, but what we plot are actually displaying
are the rows of each variable, as such we need labels for each row.

Type DataReference

Read Only No

Legend

Reference to the Legend entity that is applied to the chart.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
458 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

ShowPercentages

Should the percentages for the slices be shown.

Type bool

Read Only No

Style

Reference to the RenderStyle entity that is applied to the chart.

Type DataReference

Read Only No

Title

The title of the chart.

Type string

Read Only No

Variables

The variables to be displayed in this chart. This can be a list of Variable, VariableXY or VariableXYZ data
entities.

Type List<DataReference>

Read Only No

RenderStyle
This entity supplies the render properties for any graphics object.

Properties
BarOffset

This property controls the amount of space (relative to the BarWidth) before drawing a bar for this
variable.

For example, if two variables are being drawn in a bar chart and you set the offset of the second variable
to be 0.5, that variable will be shifted by half the BarWidth to avoid overlap.

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 459
Graphics

BarWidth

This property controls the width of bars in a bar chart. The range of allowable values is 0 to 1, and sets
the percentage of the available space used for the bars of the variable.

Type float

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

DotStyle

The symbol to be used to at each plot point.

Type DotStyles

Read Only No

FillColors

Define the fill color for this variable in the plot. All filled regions will use this color except where the
style is defined as gradient in which case the GradientColor is used.

Type List<Color>

Read Only No

FillStyle

The shading to be used for any filled region.

Type FillStyles

Read Only No

GradientAxis

The axis that defines plot color if gradient shading is enabled. The axis must be continuous.

Type Axis

Read Only No

LineColors

Defines the line color of this variable in a plot. The first value in the list will be used if the line style is
not gradient. Gradient line style will blend between the provided colors.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
460 of ANSYS, Inc. and its subsidiaries and affiliates.
Type List<Color>

Read Only No

LineStyle

The style of the line.

Type LineStyles

Read Only No

LineWidth

Sets the width of the line drawn for this variable in pixels.

Type uint

Read Only No

NumberOfColorBands

Controls the number of color bands to be used in a gradient fill. A value of 0 (the default) will result in
a continuous gradient.

Type uint

Read Only No

OutlineColors

Define the outline colors for symbols. If not set (the default) then LineColors is used.

Type List<Color>

Read Only No

ShowLinearInterpolationOfLines

When set to true, causes the ends of a line chart to extend to the edge of the chart. This is primarily
used to represent a constant line from a single value.

Type bool

Read Only No

Smoothing

Enables smoothing of the rendered object. In 3D this results in a smoothed rather than faceted surface.
In 2D this results in a smooth line rather than a straight line between points.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 461
Graphics

SymbolSize

Set the size of a symbol in pixels when a symbol is drawn for this variable. The rendered symbol size
may be slightly smaller or larger than expected if symbol does not correctly fit into the specified number
of pixels.

Type uint

Read Only No

Variable
The data entity that defines a variable to be plotted.

Properties
AutoBounds

Defines whether the bounds are to be used from BoundsMin/BoundsMax or whether they are to be
automatically generated based on the data.

Type bool

Read Only No

BoundsMax

Defines the maximum rendered value for the data. Any larger values will be ignored.

Type float

Read Only No

BoundsMin

Defines the minimum rendered value for the data. Any smaller values will be ignored.

Type float

Read Only No

DisplayAs

Controls if this variable is displayed using lines, bars, etc.

Type VariableStyle

Read Only No

FilterBoundsMax

If bounds filtering is enabled, sets the maximum variable value that will cause it to be filtered from the
plot. This is different from BoundsMin in that any variable that exceeds this value will be excluded from
the plot. This primarily applies to Parallel Coordinate Plots.

Type float

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
462 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

FilterBoundsMin

If bounds filtering is enabled, sets the minimum variable value that will cause it to be filtered from the
plot. This is different from BoundsMin in that any variable that exceeds this value will be excluded from
the plot. This primarily applies to Parallel Coordinate Plots.

Type float

Read Only No

IsFilterBoundsEnabled

When this is true, any variables that are outside the filter bounds will be excluded from the plot. This
primarily applies to Parallel Coordinate Plots.

Type bool

Read Only No

IsIncludedInLegend

Setting this parameter to 'false' will exclude this variable from any legend it may be included in.

This property is only valid for XY and XYZ charts and will be ignored otherwise.

Type bool

Read Only No

Label

The label of the variable. This is optional and is typically determined from the name of the input variable.

Type string

Read Only No

RelativeOrder

Define the order of this variable among all the variables in a chart.

Type int

Read Only No

VariableXY
This is the base class for a data entity that defines a variable to be plotted.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 463
Graphics

Properties
AutoBounds

Defines whether the bounds are to be used from BoundsMin/BoundsMax or whether they are to be
automatically generated based on the data.

Type bool

Read Only No

BoundsMax

Defines the maximum rendered value for the data. Any larger values will be ignored.

Type float

Read Only No

BoundsMin

Defines the minimum rendered value for the data. Any smaller values will be ignored.

Type float

Read Only No

DisplayAs

Controls if this variable is displayed using lines, bars, etc.

Type VariableStyle

Read Only No

FilterBoundsMax

If bounds filtering is enabled, sets the maximum variable value that will cause it to be filtered from the
plot. This is different from BoundsMin in that any variable that exceeds this value will be excluded from
the plot. This primarily applies to Parallel Coordinate Plots.

Type float

Read Only No

FilterBoundsMin

If bounds filtering is enabled, sets the minimum variable value that will cause it to be filtered from the
plot. This is different from BoundsMin in that any variable that exceeds this value will be excluded from
the plot. This primarily applies to Parallel Coordinate Plots.

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
464 of ANSYS, Inc. and its subsidiaries and affiliates.
IsFilterBoundsEnabled

When this is true, any variables that are outside the filter bounds will be excluded from the plot. This
primarily applies to Parallel Coordinate Plots.

Type bool

Read Only No

IsIncludedInLegend

Setting this parameter to 'false' will exclude this variable from any legend it may be included in.

This property is only valid for XY and XYZ charts and will be ignored otherwise.

Type bool

Read Only No

Label

The label of the variable. This is optional and is typically determined from the name of the input variable.

Type string

Read Only No

RelativeOrder

Define the order of this variable among all the variables in a chart.

Type int

Read Only No

VariableXYZ
This is the base class for a data entity that defines a variable to be plotted.

Properties
AutoBounds

Defines whether the bounds are to be used from BoundsMin/BoundsMax or whether they are to be
automatically generated based on the data.

Type bool

Read Only No

BoundsMax

Defines the maximum rendered value for the data. Any larger values will be ignored.

Type float

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 465
Graphics

Read Only No

BoundsMin

Defines the minimum rendered value for the data. Any smaller values will be ignored.

Type float

Read Only No

DisplayAs

Controls if this variable is displayed using lines, bars, etc.

Type VariableStyle

Read Only No

FilterBoundsMax

If bounds filtering is enabled, sets the maximum variable value that will cause it to be filtered from the
plot. This is different from BoundsMin in that any variable that exceeds this value will be excluded from
the plot. This primarily applies to Parallel Coordinate Plots.

Type float

Read Only No

FilterBoundsMin

If bounds filtering is enabled, sets the minimum variable value that will cause it to be filtered from the
plot. This is different from BoundsMin in that any variable that exceeds this value will be excluded from
the plot. This primarily applies to Parallel Coordinate Plots.

Type float

Read Only No

IsFilterBoundsEnabled

When this is true, any variables that are outside the filter bounds will be excluded from the plot. This
primarily applies to Parallel Coordinate Plots.

Type bool

Read Only No

IsIncludedInLegend

Setting this parameter to 'false' will exclude this variable from any legend it may be included in.

This property is only valid for XY and XYZ charts and will be ignored otherwise.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
466 of ANSYS, Inc. and its subsidiaries and affiliates.
Label

The label of the variable. This is optional and is typically determined from the name of the input variable.

Type string

Read Only No

RelativeOrder

Define the order of this variable among all the variables in a chart.

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 467
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
468 of ANSYS, Inc. and its subsidiaries and affiliates.
ICE

ICE
This container holds ICE data for an instance of IC Engine.

Methods
Refresh
Refresh ICE command.

Optional Arguments

UpstreamList A list of upstream data containers that supply data to this cell

Type List<DataContainerReference>

Reset
Reset ICE command.

Update
Update ICE command.

Data Entities
ICEData
ICE Data Object

Properties
CrankRadius

User input: Crank Radius

Type Quantity

Read Only No

CRLength

User input: Connecting Rod Length

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 469
ICE

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

EVO

User input: Engine Speed

Type Quantity

Read Only No

ICCombustionSimulationType

User input: IC Engine Combustion Simulation Type

Type ICCombustionSimulationType

Read Only No

ICIVCandEVOOption

User input: Option to get IVC and EVO values

Type ICIVCandEVOoption

Read Only No

ICSimulationType

User input: IC Engine Simulation Type

Type ICSimulationType

Read Only No

IVC

User input: Engine Speed

Type Quantity

Read Only No

LiftCurvePath

User input: Path to the valve lift curve

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
470 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

MinLift

User input: Mimimum Lift

Type Quantity

Read Only No

PistonOffset

User input: Piston Offset

Type Quantity

Read Only No

SetSolverProp

User input: Link to swtch solver from Fluent to Forte

Type string

Read Only No

ICE Setup
This container holds ICE setup data for an instance of IC Engine.

Methods
Refresh
Refresh ICE solver setup command.

Optional Arguments

UpstreamList A list of upstream data containers that supply data to this cell

Type List<DataContainerReference>

Reset
Reset ICE solver setup command.

Update
Update ICE solver setup command.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 471
ICE

Data Entities
ICESetupData
ICE Setup Data Object

Properties
CrankAngleSelector

This is link for crank angle selection or KeyGrid dialog.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ICKeyGridOption

Yes/No option for key grid

Type YN

Read Only No

ICResetMeshOnFailure

Option for reset on regen failure

Type bool

Read Only No

PostIterationJournal

User input: Path to post iteration journal file

Type string

Read Only No

PreIterationJournal

User input: Path to Pre Iteration Journal File

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
472 of ANSYS, Inc. and its subsidiaries and affiliates.
SolverSettingEditor

This is link for solver setting dialog.

Type string

Read Only No

UserBCProfileFile

User input: Path to User Boundary Condition Profiles

Type string

Read Only No

UserSettingsFilePath

User input: Path to User Boundary Conditions and Monitor Path

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 473
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
474 of ANSYS, Inc. and its subsidiaries and affiliates.
ICEM

ICEM CFD
This container holds ICEM CFD data for an instance of ICEM.

Data Entities
SimulationGeneratedMesh
Mesh data object that resides in the ICEM CFD container.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Subsets

ICEM CFD creates Subsets instead of Parts from Named Selections if set.

Type bool

Read Only No

TransferFile

The ICEM CFD downstream files are *.msh "Imported FLUENT Mesh File Type", *.poly "POLYFLOWMesh",
and *.inp "ANSYS Input File".

Type DataReference

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 475
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
476 of ANSYS, Inc. and its subsidiaries and affiliates.
IcePak

IcePak Setup
This container holds Setup data for an instance of IcePak.

Methods
Edit
User can launch the Icepak application by executing the Edit command

Optional Arguments

Interactive Passing True will run Icepak in interactive mode

Type bool

Default Value True

SystemCoordinate Optional parameter to specify the system coordinate to be displayed in the application
title

Type string

Exit
Close the Icepak session

Import
Import on the Setup container with an existing Icepak project or the compressed tzr Icepak project will
launch an Icepak session and opens the imported project

Import on the Solution container allow users to set different set of case and data files for post pro-
cessing.By default, the case and data files from the latest solution are available on the solution compon-
ent.

Required Arguments

FilePath Path to the project or tzr file when operated on Setup container. Path to the case file to be im-
ported when operated on the Solution container

Type string

Example
When the Import is called on the Setup container

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 477
IcePak

Icepak.Import(FilePath=r"E:\DSModels\ICE\demo1_files\dp0\IPK\Icepak\IcepakProj")

When the Import is called on the Setup container with tzr file

Icepak.Import(FilePath=r"c:\Temp\test.tzr")

When the Import is called on the Solution container

Icepak.Import(FilePath=r"D:\IcepakProj00.cfd.cas")

Data Entities
IcePakSetup
Represents the IcepakSetup data entity

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

WorkbenchColorScheme

Setting this property will force Icepak to use the Workbench color scheme. Unsetting this property will
allow Icepak to use the default color scheme set inside Icepak

Type bool

Read Only No

IcePak Solution
This container holds Solution data for an instance of IcePak.

Methods
Import
Import on the Setup container with an existing Icepak project or the compressed tzr Icepak project will
launch an Icepak session and opens the imported project

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
478 of ANSYS, Inc. and its subsidiaries and affiliates.
Import on the Solution container allow users to set different set of case and data files for post pro-
cessing.By default, the case and data files from the latest solution are available on the solution compon-
ent.

Required Arguments

FilePath Path to the project or tzr file when operated on Setup container. Path to the case file to be im-
ported when operated on the Solution container

Type string

Example
When the Import is called on the Setup container

Icepak.Import(FilePath=r"E:\DSModels\ICE\demo1_files\dp0\IPK\Icepak\IcepakProj")

When the Import is called on the Setup container with tzr file

Icepak.Import(FilePath=r"c:\Temp\test.tzr")

When the Import is called on the Solution container

Icepak.Import(FilePath=r"D:\IcepakProj00.cfd.cas")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 479
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
480 of ANSYS, Inc. and its subsidiaries and affiliates.
Mechanical APDL

Mechanical APDL
This container holds data for a Mechanical APDL analysis.

Methods
AddFile
Copies the specified file to the working directory of the Mechanical APDL editor and registers the file
with the Workbench project.

AddInputFile
Specifies an input file containing APDL commands for the Mechanical APDL editor for execution when
the editor opens. Copies the file to the application working directory and registers it with the Workbench
project.

Edit
Opens the Mechanical APDL editor to allow modification of Analysis data.

Exit
Exits the Mechanical APDL editor.

GetAnalysisSettings
Query to return the reference to the container's AnalysisSettings data entity.

GetComponentSettingsForRsmDpUpdate
This query is used to obtain the ComponentSettingsForRsmDpUpdate object for Journaling and
Scripting

GetMapdlInputFile
Query to return the reference to the container's MapdlSetup data entity.

GetMapdlSetup
Query to return the reference to the container's MapdlSetup data entity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 481
Mechanical APDL

GetSolutionSettings
This query is used to obtain the solution settings object for Journaling and Scripting

SendCommand
Sends commands to the Mechanical APDL editor.

SwitchToBackgroundMode
Switch the Update in progress into background mode. This will enable operations that are not allowed
during an Update in foreground mode (e.g. Project Save).

This command is not normally useful in a script. Journals may record the invocation of this command
after an Update invoke, as the result of GUI activity while the Update is in progress. However, replay of
these journals will always wait for the Update invoke to complete before invoking the next command,
rendering this step ineffectual.

Data Entities
ExtendedComponentSettingsForRsmDpUpdate
Extended Component settings when solved as part of design point update via RSM Currently used for
Addins with solvers that would like to take advantage of SMP

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

LimitOnNumberOfCores

The number of processes that the RSM-based design point update should not exceed during execution.

Type int

Read Only No

SerialOnly

Indicates whether or not to execute only serially.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
482 of ANSYS, Inc. and its subsidiaries and affiliates.
SharedMemoryParallel

A boolean flag indicating whether or not to restrict the solver to using SMP, instead of distributed
parallel

Type bool

Read Only No

UseLimitOnNumberOfCores

Indicates whether to limit the number of processes for parallel execution.

Type bool

Read Only No

MapdlInputFile
Represents an input file for the Mechanical APDL editor.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Methods
Delete

Deletes an input or reference file from the Mechanical APDL editor.

PublishMapdlParameter

Publishes a MAPDL variable located in an input file as a parameter.

SwitchInputOrder

Switches the order of two input files for the Mechanical APDL editor.

UnpublishMapdlParameter

a MAPDL variable located in an input file as a parameter.

MapdlReferenceFile
Represents a reference file for the Mechanical APDL editor.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 483
Mechanical APDL

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Methods
Delete

Deletes an input or reference file from the Mechanical APDL editor.

MapdlSetup
Represents the settings used to launch the Mechanical APDL editor.

Properties
CommandLineOptions

Additional command line options for the Mechanical APDL editor.

Type string

Read Only No

CustomExecutablePath

Calls a custom ANSYS executable.

Type string

Read Only No

DatabaseMemory

Defines the portion of workspace (memory) to be used for the database. The default is 512 MB for 64-
bit machines, 256 MB for 32-bit machines.

Type int

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
484 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

Distributed

Enables Distributed ANSYS.

Type bool

Read Only No

DownloadDistributedFiles

Indicates whether or not to download files from slave node scratches during distributed solves

Type bool

Read Only No

GPUAccelerator

Specifies the type of GPU Accelerators. By default this is set to none meaning no GPU acceleration is
used.

Type GPUAccelerator

Read Only No

Graphics

Specifies the type of graphics device. This option applies only to interactive mode. For UNIX/Linux sys-
tems, graphics device choices are X11, X11C, or 3D. For Windows systems, graphics device options are
WIN32 or WIN32C, or 3D.

Type string

Read Only No

JobName

Specifies the initial jobname, a name assigned to all files generated by the program for a specific
model. If you omit the -j option, the jobname is assumed to be file.

Type string

Read Only No

License

Defines which ANSYS product will run during the session (ANSYS Multiphysics, ANSYS Structural, etc.).

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 485
Mechanical APDL

MachineList

Specifies the machines on which to run a Distributed ANSYS analysis.

Type string

Read Only No

MPIType

Defines which type of MPI the solver should use.

Type MPIType

Read Only No

NumberOfGpusPerMachine

Specifies the number of accelerators to use when running with GPU Acceleration.

Type int

Read Only No

Processors

Specifies the number of processors to use when running Distributed ANSYS or Shared-memory ANSYS.

Type int

Read Only No

ReadStartAns

Specifies whether the program reads the start121.ans file at start-up.

Type bool

Read Only No

WorkspaceMemory

Specifies the total size of the workspace (memory) in megabytes. If you omit the -m option, the default
is 1 GB (1024 MB) for 64-bit machines, 512 MB for 32-bit machines.

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
486 of ANSYS, Inc. and its subsidiaries and affiliates.
Mechanical

Mechanical Enhanced Model

This container holds Imported Section data for an instance of ANSYS Mechanical.

Methods
Edit
Opens the Mechanical editor and attaches geometry.

Optional Arguments

Hidden Specify if Mechanical will open in hidden mode. The default value is false.

Type bool

Default Value False

Interactive Specify if Mechanical will open in interactive mode. The default value is true.

Type bool

Default Value True

StartAsReadOnly Specify if Mechanical will open in read-only mode. The default value is false.

Type bool

Default Value False

Example
To edit the enhanced model component with default optional parameter values:

enhancedModel.Edit()

Or by specifying optional parameter values:

enhancedModel.Edit(Interactive=True)

Exit
Exit the Mechanical editor

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 487
Mechanical

Optional Arguments

SaveDatabase Indicates whether the Mechanical database will be saved prior to exiting

Type bool

Default Value True

Mechanical Model
This container holds Model data for an instance of ANSYS Mechanical.

Methods
Edit
Opens the Mechanical editor and attaches geometry.

Optional Arguments

Hidden Specify if Mechanical will open in hidden mode. The default value is false.

Type bool

Default Value False

Interactive Specify if Mechanical will open in interactive mode. The default value is true.

Type bool

Default Value True

StartAsReadOnly Specify if Mechanical will open in read-only mode. The default value is false.

Type bool

Default Value False

Example
To edit the model component with default optional parameter values:

model.Edit()

Or by specifying optional parameter values:

model.Edit(Interactive=True)

Exit
Exit the Mechanical editor

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
488 of ANSYS, Inc. and its subsidiaries and affiliates.
Optional Arguments

SaveDatabase Indicates whether the Mechanical database will be saved prior to exiting

Type bool

Default Value True

Export
Exports a .dsdb file for the model component.

Required Arguments

FilePath The path and name of the .dsdb file to be written.

Type string

ExportASMJournal
Exports an ASM Journal (.wbjn) and supporting files for the model component.

Required Arguments

FilePath The path and name of the .wbjn file to be written. Supporting files written alongside.

Type string

ExportGeometry
Exports a PartManager database (.pmdb) file for the geometry in the model component.

Required Arguments

FilePath The path and name of the .pmdb file to be written.

Type string

ExportMesh
Exports a .acmo file for the mesh in the model component.

Required Arguments

FilePath The path and name of the .acmo file to be written.

Type string

GetMechanicalMesh
Query to return the reference to the container's MechanicalMesh data entity.

Return A reference to the requested MechanicalMesh data entity.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 489
Mechanical

GetMechanicalMeshFile
Query to return the reference to the container's MechanicalMeshFile data entity.

Return A reference to the requested MechanicalMeshFile data entity.

Type DataReference

GetMechanicalModel
Query to return the reference to the container's MechanicalModel data entity.

Return A reference to the requested MechanicalModel data entity.

Type DataReference

GetMechanicalSystemType
Query to return the reference to the container's MechanicalSystemType data entity.

Return A reference to the requested MechanicalSystemType data entity.

Type DataReference

GetSimulationImportOptions
Query to return the data reference to the simulation import options

Return The Data Entity containing settings for this component.

Type DataReference

Required Arguments

Name The entity of interest.

Type string

SendCommand
Executes a JScript or python command in the Mechanical editor.

If the Mechanical editor is not open, then the editor's GUI will not be available, causing some commands
to fail. In this case, consider calling the container's Edit method to open the editor before using Send-
Command.

Furthermore, if the Mechanical editor is not open, SendCommand will start the editor without the GUI,
issue the specified command, and then close the editor. For multiple SendCommands, this may degrade
performance.

Required Arguments

Com- Command argument containing the command.

mand
Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
490 of ANSYS, Inc. and its subsidiaries and affiliates.
Optional Arguments

Language Language of the command. The default value of Language is "Javascript".

Type string

Default Value Javascript

Example
To execute some arbitrary command (in this case, causing a dialog box to appear) in the Mechanical editor:

model.SendCommand(Command="WBScript.Out(\"My Text\",true);" )

To run a JScript file already saved to disk using Run Macro from Mechanical:

setup.SendCommand(Command="WB.AppletList.Applet(\"DSApplet\").App.Script.doToolsRunMacro(\"C:\\\\macro.js\"

Data Entities
GeneralModelAssemblyProperties
Class used to expose general properties for the model assembly workflow

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

GroupObjectsBySource

Group objects in Mechanical based on source

Type bool

Read Only No

LengthUnit

Length unit of assembled model

Type string

Read Only No

ObjectRenaming

Name objects in Mechanical based on selected option

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 491
Mechanical

Type ObjectRenamingType

Read Only No

MechanicalMesh
This is the mesh data entity object that will exist in the model container.

Properties
Caption

Caption used to identify the mesh.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

MeshId

Mesh identifier that corresponds with Mesh ID in Mechanical

Type int

Read Only No

MechanicalModel
The model data entity in the model container.

Properties
AcpAllowRenumberingList

ACP automatic renumbering of transfer information

Type Dictionary<DataContainerReference, bool>

Read Only No

AcpRenumberingInformation

ACP automatic renumbering of transfer information

Type Dictionary<string, List<DataReference>>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
492 of ANSYS, Inc. and its subsidiaries and affiliates.
AllowMeshing

Property used to prevent a re meshing in model assembly workflows

Type bool

Read Only No

Caption

Caption to identify the model

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

EdaFile

Reference to a material database

Type DataReference

Read Only No

File

Reference to the Mechanical database

Type DataReference

Read Only No

IsResetNotRequired

Property used to prevent cascasding resets on downstream containers

Type bool

Read Only No

ModelConversionAssociativityMap

ACP automatic renumbering of transfer information

Type Dictionary<string, string>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 493
Mechanical

ModelId

Model identifier that corresponds with the ID on Model tree node in Mechanical

Type int

Read Only No

PrototypeId

Prototype identifier which corresponds to the ID on the Geometry tree node in Mechanical

Type int

Read Only No

MechanicalSystemType
This entity provides string based information about the physics, analysis, and solver settings for the
Mechanical system component.

Properties
AnalysisTypeDisplayString

The string which represents current analysis type setting.

Type string

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

PhysicsTypeDisplayString

The string which represents current physics type setting.

Type string

Read Only Yes

SolverTypeDisplayString

The string which represents current solver type setting.

Type string

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
494 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConversionOptionsEntity
(Beta) Entity to control the Skin Detection algorithm for importing cdb files.

Properties
BodyGroupingType

Body grouping type

Type BodyGroupingType

Read Only No

CutAngle

Only displayed if Forbid Close Components equals Yes. It is the angle used to cut closed surfaces to
separate the elements into components.

Type Quantity

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ForbidCloseComponents

Option to split closed surfaces into several components.If Yes then the algorithm cuts closed surfaces
into several components. It provides a simple method to avoid problematic faces on closed surfaces.

Type bool

Read Only No

GeometryImportAnalysisType

The geometry attach type for the CDB file

Type GeometryAttachType

Read Only No

NodalComponentKey

If the nodal components will be processed during CDB components the nodal component key will allow
filtering of which components to process

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 495
Mechanical

Read Only No

ProcessNodalComponents

Should the nodal components be processed during CDB conversion

Type bool

Read Only No

ToleranceAngle

The tolerance angle to seperate two elements into seperate components. If the angle between the
normals of two adjacent elements is less than or equal to the Tolerance Angle then the two elements
are in the same component, otherwise, they are separated.

Type Quantity

Read Only No

ModelOutputSettingsForACP
Entity to control the properties of mesh file generated by Mechanical Model.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

LengthUnit

Length unit to write mesh file.

Type string

Read Only No

SimulationImportOptions
Import options for model assembly available on the downstream model

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
496 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

NumberOfCopies

By default this value is 0, specifies how many additional copies of the upstream model are needed

Type int

Read Only No

RenumberMeshElementsAutomatically

By default this value is true, specifies whether the user would like us to automatically renumber his
mesh elements to prevent unique id conflicts during assembly

Type bool

Read Only No

RigidTransform

Rigid Transformations for the Source Geometry

Type RigidTransformOptions

Read Only No

Source

The upstream model source

Type DataReference

Read Only No

Mechanical Results
This container holds Results data for an instance of ANSYS Mechanical.

Methods
Edit
Opens the Mechanical editor and attaches geometry.

Optional Arguments

Hidden Specify if Mechanical will open in hidden mode. The default value is false.

Type bool

Default Value False

Interactive Specify if Mechanical will open in interactive mode. The default value is true.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 497
Mechanical

Type bool

Default Value True

StartAsReadOnly Specify if Mechanical will open in read-only mode. The default value is false.

Type bool

Default Value False

Example
To edit the results component with default optional parameter values.

result.Edit()

Or by specifying optional parameter values:

result.Edit(Interactive=True)

Exit
Exit the Mechanical editor

Optional Arguments

SaveDatabase Indicates whether the Mechanical database will be saved prior to exiting

Type bool

Default Value True

GetMechanicalSystemType
Query to return the reference to the container's MechanicalSystemType data entity.

Return A reference to the requested MechanicalSystemType data entity.

Type DataReference

GetModalOptionsForCdb
Query to return the component reference for a given container and component base name.

Return A reference to the requested data entity.

Type DataReference

GetSimulationImportOptionsForResult
Query to return the component reference for a given container and component base name.

Return A reference to the requested data entity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
498 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataReference

GetSimulationResultFile
Query to return the component reference for a given container and component base name.

Return A reference to the requested data entity.

Type DataReference

GetStaticOptionsForCdb
Query to return the component reference for a given container and component base name.

Return A reference to the requested data entity.

Type DataReference

SendCommand
Executes a JScript or python command in the Mechanical editor.

If the Mechanical editor is not open, then the editor's GUI will not be available, causing some commands
to fail. In this case, consider calling the container's Edit method to open the editor before using Send-
Command.

Furthermore, if the Mechanical editor is not open, SendCommand will start the editor without the GUI,
issue the specified command, and then close the editor. For multiple SendCommands, this may degrade
performance.

Required Arguments

Com- Command argument containing the command.

mand
Type string

Optional Arguments

Language Language of the command. The default value of Language is "Javascript".

Type string

Default Value Javascript

Example
To execute some arbitrary command (in this case, causing a dialog box to appear) in the Mechanical editor:

model.SendCommand(Command="WBScript.Out(\"My Text\",true);" )

To run a JScript file already saved to disk using Run Macro from Mechanical:

setup.SendCommand(Command="WB.AppletList.Applet(\"DSApplet\").App.Script.doToolsRunMacro(\"C:\\\\macro.js\"

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 499
Mechanical

Data Entities
ModalOptionsForCdb
ModalOptionsForCdb

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Mode

Time

Type int

Read Only No

ScaleFactor

Scale Factor

Type double

Read Only No

SimulationImportOptionsForResult
Import options for model assembly available on the downstream model

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

LengthUnit

Length unit of cdb

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
500 of ANSYS, Inc. and its subsidiaries and affiliates.
NumberOfCopies

By default this value is 0, specifies how many additional copies of the upstream model are needed

Type int

Read Only No

RenumberMeshElementsAutomatically

By default this value is true, specifies whether the user would like us to automatically renumber his
mesh elements to prevent unique id conflicts during assembly

Type bool

Read Only No

RigidTransform

Rigid Transformations for the Source Geometry

Type RigidTransformOptions

Read Only No

Source

The upstream model source

Type string

Read Only No

StaticOptionsForCdb
StaticOptionsForCdb

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ScaleFactor

Scale Factor

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 501
Mechanical

Time

Time

Type double

Read Only No

Mechanical Setup
This container holds Set Up data for an instance of ANSYS Mechanical.

Methods
Edit
Opens the Mechanical editor and attaches geometry.

Optional Arguments

Hidden Specify if Mechanical will open in hidden mode. The default value is false.

Type bool

Default Value False

Interactive Specify if Mechanical will open in interactive mode. The default value is true.

Type bool

Default Value True

StartAsReadOnly Specify if Mechanical will open in read-only mode. The default value is false.

Type bool

Default Value False

Example
To edit the setup component with default optional parameter values.

setup.Edit()

Or by specifying optional parameter values:

setup.Edit(Interactive=True)

Exit
Exit the Mechanical editor

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
502 of ANSYS, Inc. and its subsidiaries and affiliates.
Optional Arguments

SaveDatabase Indicates whether the Mechanical database will be saved prior to exiting

Type bool

Default Value True

Export
Writes either an APDL input file (for use with the ANSYS solver) or a CAE Representation file (for use
with any solver).

Required Arguments

Path If the SetupDataType is 'InputFile', this should be a file path. If the SetupDataType is
'CAERepresentation', this should be a folder path.

Type string

SetupDataType Type of setup data to write to disk. Available options are: 'InputFile' and 'CAERepresenta-
tion'.

Type string

GetMechanicalSetupFile
Query to return the reference to the container's MechanicalSetupFile data entity.

Return A reference to the requested MechanicalSetupFile data entity.

Type DataReference

GetMechanicalSystemType
Query to return the reference to the container's MechanicalSystemType data entity.

Return A reference to the requested MechanicalSystemType data entity.

Type DataReference

SendCommand
Executes a JScript or python command in the Mechanical editor.

If the Mechanical editor is not open, then the editor's GUI will not be available, causing some commands
to fail. In this case, consider calling the container's Edit method to open the editor before using Send-
Command.

Furthermore, if the Mechanical editor is not open, SendCommand will start the editor without the GUI,
issue the specified command, and then close the editor. For multiple SendCommands, this may degrade
performance.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 503
Mechanical

Required Arguments

Com- Command argument containing the command.

mand
Type string

Optional Arguments

Language Language of the command. The default value of Language is "Javascript".

Type string

Default Value Javascript

Example
To execute some arbitrary command (in this case, causing a dialog box to appear) in the Mechanical editor:

model.SendCommand(Command="WBScript.Out(\"My Text\",true);" )

To run a JScript file already saved to disk using Run Macro from Mechanical:

setup.SendCommand(Command="WB.AppletList.Applet(\"DSApplet\").App.Script.doToolsRunMacro(\"C:\\\\macro.js\"

SetDesignAssessmentFile
Set the design assessment

Required Arguments

FilePath The design assessment file's path.

Type string

Data Entities
DesignAssessmentSetupSettingsType
The data entity that holds the setup properties for a Design Assessment.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

SolverTarget

The type of assessment to be performed.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
504 of ANSYS, Inc. and its subsidiaries and affiliates.
Type string

Read Only No

UserAttributeFile

The file to specify attributes to perform a User Defined design assessment.

Type string

Read Only No

Mechanical Solution
This container holds Solution data for an instance of ANSYS Mechanical.

Methods
Edit
Opens the Mechanical editor and attaches geometry.

Optional Arguments

Hidden Specify if Mechanical will open in hidden mode. The default value is false.

Type bool

Default Value False

Interactive Specify if Mechanical will open in interactive mode. The default value is true.

Type bool

Default Value True

StartAsReadOnly Specify if Mechanical will open in read-only mode. The default value is false.

Type bool

Default Value False

Example
To edit the solution component with default optional parameter values.

solution.Edit()

Or by specifying optional parameter values:

solution.Edit(Interactive=True)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 505
Mechanical

Exit
Exit the Mechanical editor

Optional Arguments

SaveDatabase Indicates whether the Mechanical database will be saved prior to exiting

Type bool

Default Value True

Export
Exports the results(*.db, *.rth, *.rmg, and *.rst) files to given DirectoryPath.

Required Arguments

DirectoryPath Directory path to export the result files to.

Type string

GetComponentSettingsForRsmDpUpdate
This query is used to obtain the ComponentSettingsForRsmDpUpdate object for Journaling and
Scripting

GetExpertProperties
This query is used to obtain the ExpertProperties object for Journaling and Scripting

GetMechanicalSystemType
Query to return the reference to the container's MechanicalSystemType data entity.

Return A reference to the requested MechanicalSystemType data entity.

Type DataReference

GetSolutionSettings
Returns a DataReference to the Solution Settings object for this container

Return The Data Entity containing settings for this component.

Type DataReference

SendCommand
Executes a JScript or python command in the Mechanical editor.

If the Mechanical editor is not open, then the editor's GUI will not be available, causing some commands
to fail. In this case, consider calling the container's Edit method to open the editor before using Send-
Command.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
506 of ANSYS, Inc. and its subsidiaries and affiliates.
Furthermore, if the Mechanical editor is not open, SendCommand will start the editor without the GUI,
issue the specified command, and then close the editor. For multiple SendCommands, this may degrade
performance.

Required Arguments

Com- Command argument containing the command.

mand
Type string

Optional Arguments

Language Language of the command. The default value of Language is "Javascript".

Type string

Default Value Javascript

Example
To execute some arbitrary command (in this case, causing a dialog box to appear) in the Mechanical editor:

model.SendCommand(Command="WBScript.Out(\"My Text\",true);" )

To run a JScript file already saved to disk using Run Macro from Mechanical:

setup.SendCommand(Command="WB.AppletList.Applet(\"DSApplet\").App.Script.doToolsRunMacro(\"C:\\\\macro.js\"

Data Entities
ExtendedComponentSettingsForRsmDpUpdate
Extended Component settings when solved as part of design point update via RSM Currently used for
Addins with solvers that would like to take advantage of SMP

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

LimitOnNumberOfCores

The number of processes that the RSM-based design point update should not exceed during execution.

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 507
Mechanical

SerialOnly

Indicates whether or not to execute only serially.

Type bool

Read Only No

SharedMemoryParallel

A boolean flag indicating whether or not to restrict the solver to using SMP, instead of distributed
parallel

Type bool

Read Only No

UseLimitOnNumberOfCores

Indicates whether to limit the number of processes for parallel execution.

Type bool

Read Only No

SimulationSolutionSettings
Mechanical specific simulation solution settings entity used for Journaling and Scripting. Not based on
the common Infrastructure.Rsm.Queries entity.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Queue

The queue that will be used on RSM task

Type string

Read Only Yes

SolveManager

Solve Manager used on RSM task.

Type string

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
508 of ANSYS, Inc. and its subsidiaries and affiliates.
SolveProcessSetting

Solve process setting used on RSM task.

Type string

Read Only No

UpdateOption

Used to specify the type of update, local or RSM.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 509
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
510 of ANSYS, Inc. and its subsidiaries and affiliates.
Mesh

Mesh
This container holds Mesh data for an instance of the Meshing application.

Methods
Edit
Opens the Meshing editor. If the editor has never been opened, the command will import the geometry
file associated with the Geometry cell in the Mesh system.

Optional Arguments

Interactive Specifies whether the editor should open in interactive mode. The default value is true.

Type bool

Default Value True

Example
To edit the mesh component with default optional parameter values:

mesh.Edit()

Or by specifying optional parameter values:

mesh.Edit(Interactive=True )

Exit
Exits the Meshing editor.

Optional Arguments

SaveDatabase Bool flag to save the database on exit of the editor

Type bool

Default Value True

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 511
Mesh

Export
Saves the current state of the Meshing editor and exports a *.meshdat file. If the Meshing editor is not
currently open, the cached state (the state of the editor the last time it was closed) of the Meshing
editor will be exported.

Required Arguments

FilePath The path and name of the .meshdat file to be written.

Type string

ExportASMJournal
Exports an ASM Journal (.wbjn) and supporting files for the model component.

Required Arguments

FilePath The path and name of the .wbjn file to be written. Supporting files written alongside.

Type string

ExportGeometry
Exports a PartManager database (.pmdb) file for the geometry in the model component.

Required Arguments

FilePath The path and name of the .pmdb file to be written.

Type string

ExportMesh
Exports a .acmo file for the mesh in the model component.

Required Arguments

FilePath The path and name of the .acmo file to be written.

Type string

GetMechanicalMeshFile
Returns the data reference to the container's MechanicalMeshFile data entity.

Return A reference to the requested MechanicalMeshFile data entity.

Type DataReference

GetMechanicalModel
Returns the data reference to the container's MechanicalModel data entity.

Return A reference to the requested MechanicalModel data entity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
512 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataReference

GetMechanicalSystemType
Returns the data reference to the container's MechanicalSystemType data entity.

Return A reference to the requested MechanicalSystemType data entity.

Type DataReference

GetMeshingImportOptions
Query to return the data reference to the meshing import options

Return The Data Entity containing settings for this component.

Type DataReference

Required Arguments

Name The entity of interest.

Type string

Import
Import a mesh data file. This action will delete the geometry container from the Mesh system and
convert the Mesh cell into a file container. It is not possible to view meshes that are imported through
this command in the Meshing editor; however, the files imported can be transferred to downstream
mesh consumers (such as CFX, FLUENT, etc.) by way of normal component to component data transfer.

Required Arguments

FilePath The data file to be imported.

Type string

MeshType The type of mesh data file.

Type MeshFileType

Example
To import a data file into the mesh component with default optional parameter values:

mesh.Import(FilePath=r"C:\temp\data.cfx", MeshType="CFX")

ImportRepositoryMesh
Import a mesh data file from a repository location. This action will delete the geometry container from
the Mesh system and convert the Mesh cell into a file container. It is not possible to view meshes that
are imported through this command in the Meshing editor; however, the files imported can be transferred
to downstream mesh consumers (such as CFX, FLUENT, etc.) by way of normal component to component
data transfer.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 513
Mesh

Required Arguments

File The data file to be imported from the repository.

Type DataReference

MeshType The type of mesh data file.

Type MeshFileType

SendCommand
Sends commands to the Meshing editor using JScript or Python syntax.

If the Meshing editor is not open, then the editor's GUI will not be available to the script, causing some
commands to fail. In this case, consider calling Edit() to open the editor before using SendCommand.
Furthermore,if the Meshing editor is not open,SendCommand will start the editor without GUI,issue the
specified command,and then close the editor. For multiple SendCommands,this may degrade perform-
ance.

Required Arguments

Com- The command(s) to execute in the Meshing editor.

mand
Type string

Optional Arguments

Language Language of the command. The default value of Language is "Javascript".

Type string

Default Value Javascript

Example
To execute some arbitrary command (in this case, causing a dialog box to appear) in the Meshing editor:

mesh.SendCommand(Command=r"WBScript.Out("My Text",true);" )

Data Entities
GeneralMeshAssemblyProperties
Class used to expose general properties for the mesh assembly workflow

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
514 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

GroupObjectsBySource

Group objects in Meshing based on source

Type bool

Read Only No

LengthUnit

Target Length Unit for Assembled Model

Type string

Read Only No

ObjectRenaming

Name objects in Meshing based on selected option

Type ObjectRenamingType

Read Only No

MechanicalModel
The data entity that contains the identifiers which maintain a relationship between the Mesh data
contain and the objects in the Meshing editor tree.

Properties
Caption

Caption to identify the model.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ModelId

Identifier which corresponds to the Model object in the Meshing editor tree. This ID can be used in
conjunction with SendCommand to perform operations such as inserting mesh controls or manipulating
mesh settings within the Meshing editor itself.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 515
Mesh

Type int

Read Only No

PrototypeId

Identifier which corresponds to the Geometry object in the Meshing editor tree. This ID can be used in
conjunction with SendCommand to perform operations such as inserting mesh controls or manipulating
mesh settings within the Meshing editor itself.

Type int

Read Only No

MechanicalSystemType
This entity provides string based information about the physics, analysis, and solver settings for the
Mesh component. As the Mesh component may be used independent of any specific physics, analysis,
or solver, the properties exposed by this entity may take a value of "Any", meaning simply that it is up
to the user to initialize and correctly configure the mesh settings within the Meshing editor.

Properties
AnalysisTypeDisplayString

The string which represents the current analysis type setting - this value will always be "Any".

Type string

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ICEngineAutoSetup

The boolean which represents the IC Engine mesh setup options.

Type bool

Read Only No

ICEngineMeshSettings

The string is a hyper link which opens the IC Engine mesh setting dialog.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
516 of ANSYS, Inc. and its subsidiaries and affiliates.
PhysicsTypeDisplayString

The string which represents current physics type setting - the value can be "Any" or "CFD".

Type string

Read Only Yes

RefMeshSize

No details are provided for this entry.

Type Quantity

Read Only No

SolverTypeDisplayString

The string which represents the current solver setting - the value can be "Any", "FLUENT", "CFX", or
"POLYFLOW".

Type string

Read Only Yes

MeshingImportOptions
Import options for model assembly available on the downstream model

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

NumberOfCopies

By default this value is 0, specifies how many additional copies of the upstream mesh are needed

Type int

Read Only No

RenumberMeshElementsAutomatically

By default this value is true, specifies whether the user would like us to automatically renumber his
mesh elements to prevent unique id conflicts during assembly

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 517
Mesh

RigidTransform

Rigid Transformations for the Source Geometry

Type RigidTransformOptions

Read Only No

Source

The upstream mesh source

Type DataReference

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
518 of ANSYS, Inc. and its subsidiaries and affiliates.
Microsoft Office Excel Analysis

Microsoft Office Excel Analysis

This container holds information to expose data from an instance of Microsoft Excel as Workbench para-
meters.

Methods
GetExcelSetup
Get the DataReference of the MSExcelSetup entity. There is only one MSExcelSetup entity per Analysis
container. An exception is thrown if the entity is not found.

Return The DataReference of the MSExcelSetup entity.

Type DataReference

Example
The following example shows how the user can get a setup entity to set a different NamedRangeKey value.

system1 = GetSystem(Name="XLS")
analysis1 = system1.GetContainer(ComponentName="Analysis")
setup1 = analysis1.GetExcelSetup()
setup1.NamedRangeKey = "MyPrefix"

Data Entities
MSExcelFile
This entity represents an Excel file added to the Analysis container in order to expose data as Workbench
parameters and perform calculations based on parameters. It is created by the MSExcelSetup.AddFile
method which copies and registers the original user's file into the project files.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 519
Microsoft Office Excel Analysis

ErrorMessage

Error message if the calculation failed.

Type string

Read Only No

FileName

Name of the file.

Type string

Read Only No

MacroName

Name of the macro used to calculate the workbook.

Type string

Read Only No

OriginalFilePath

Original Path of the file.

Type string

Read Only No

State

Calculation state of the file.

Type Status

Read Only No

UseMacro

Set to True if a Visual Basic macro is used to calculate the workbook.

Type bool

Read Only No

Methods
GetRange

Gets the DataReference of an MSExcelRange entity from its name. An exception is thrown if the entity
is not found.

Return The DataRefence of the MSExcelRange entity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
520 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataReference

Required Arguments

Name The Name of the MSExcelRange to retrieve.

Type string

Example
The following example shows how the user can get an MSExcelRange named "WB_Thickness".

system1 = GetSystem(Name="XLS")
analysis1 = system1.GetContainer(ComponentName="Analysis")
setup1 = analysis1.GetExcelSetup()
file1 = setup1.GetFile()
range1 = file1.GetRange(Name="WB_Thickness")
write range1.CellRange
write range1.Value

GetRanges

Gets the list of all MSExcelRange entities.

Return The DataReferenceSet containing all the MSExcelRange entities associated

with the MSExcelFile.

Type DataReferenceSet

Example
The following example shows how the user can get all the MSExcelRange entities of an MSExcelFile.

system1 = GetSystem(Name="XLS")
analysis1 = system1.GetContainer(ComponentName="Analysis")
setup1 = analysis1.GetExcelSetup()
file1 = setup1.GetFile()
ranges = file1.GetRanges()

PublishParameter

Publishes an MSExcelRange as a Parameter in the Workbench project. The IsOutput argument allows
to publish the range as an input or an output parameter. The method returns the created Parameter
entity.

Return DataReference of the created parameter.

Type DataReference

Required Arguments

ExcelRange The MSExcelRange to be published as a parameter.

Type DataReference

Optional Arguments

IsOutput True to specify that the range is published as an output parameter, or false for input parameter.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 521
Microsoft Office Excel Analysis

Type bool

Default Value False

Example
The following example shows how to publish ranges as input or output parameters.

system1 = GetSystem(Name="XLS")
analysis1 = system1.GetContainer(ComponentName="Analysis")
setup1 = analysis1.GetExcelSetup()
file = setup1.AddFile(FilePath="C:\Test\ProcessCalculation.xlsx")
ValvePosition = file.GetRange(Name="WB_Valve_Position")
T1 = file.GetRange(Name="WB_T1")
input1 = file.PublishParameter( ValvePosition )
output1 = file.PublishParameter( T1 )

Reload

Reloads an MSExcelFile to synchronize the data between the Microsoft Office Excel application and
Workbench. For instance, it is necessary to call this method when the ExcelSetup.NamedRangeKey has
been modified, in order to filter the named ranges based on the new NamedRangeKey's value. It is also
necessary to reload the file if the workbook has been edited outside of Workbench, for instance to
change a formula. The method recreates MSExcelRange and Parameter entities as required. The existing
results in Workbench are invalidated.

Example
The following example shows how to reload a file.

system1 = GetSystem(Name="XLS")
analysis1 = system1.GetContainer(ComponentName="Analysis")
setup1 = analysis1.GetExcelSetup()
file = setup1.GetFile()
file.Reload()

UnpublishParameter

Unpublishes an MSExcelRange as a Parameter from the Workbench project, which means deleting the
Parameter entity that was created in association to this MSExcelRange.

Required Arguments

ExcelRange The MSExcelRange to unpublish.

Type DataReference

Example
The following example shows how to publish and unpublish ranges as input or output parameters.

system1 = GetSystem(Name="XLS")
analysis1 = system1.GetContainer(ComponentName="Analysis")
setup1 = analysis1.GetExcelSetup()
file = setup1.AddFile(FilePath="C:\Test\ProcessCalculation.xlsx")
ValvePosition = file.GetRange(Name="WB_Valve_Position")
input1 = file.PublishParameter( ValvePosition )
T1 = file.GetRange(Name="WB_T1")
output1 = file.PublishParameter( T1 )
file.UnpublishParameter(ValvePosition)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
522 of ANSYS, Inc. and its subsidiaries and affiliates.
 file.UnpublishParameter(T1)

MSExcelRange
This entity represents an Excel named range that matches the prefix string define by the Parameter
Key. The MSExcelRange entities are created automatically when an Excel file is added, or reloaded, by
filtering all the named ranges found in the Excel workbook with the Parameter Key. The MSExcelRange
is not published as a parameter by default: use the MSExcelFile.PublishParameter method to expose
the range as an input or output parameter in the Workbench project. The named ranges can contain
a single cell for the value, or two cells for the value and the unit string.

Properties
CellRange

The coordinates defining the Excel range in the workbook.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Value

The current value of the range.

Type Quantity

Read Only No

ValueQuantityName

The quantity name.

Type string

Read Only No

Methods
GetParameter

Gets the Parameter entity associated with a published MSExcelRange entity. If the MSExcelRange is not
published as a parameter, the method returns null.

Return The Parameter associated with the MSExcelRange, or null if it is not pub-
lished.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 523
Microsoft Office Excel Analysis

Type DataReference

Example
The following example shows how the user can get the parameter associated with a range.

system1 = GetSystem(Name="XLS")
analysis1 = system1.GetContainer(ComponentName="Analysis")
setup1 = analysis1.GetExcelSetup()
file1 = setup1.GetFile()
range1 = file1.GetRange(Name="WB_Thickness")
parameter1 = range1.GetParameter()
write parameter1.Name

MSExcelSetup
This entity holds properties to setup the data exchange with the Microsoft Office Excel application and
information about the state of the connection with the instance of Microsoft Office Excel. There is one
unique MSExcelSetup entity instance per Analysis container.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ExcelStatus

Status of the connection with the instance of the Microsoft Office Excel application.

Type ExcelConnectionState

Read Only Yes

ExcelVersion

Version number of the Microsoft Office Excel instance connected with Workbench.

Type string

Read Only Yes

NamedRangeKey

The Named Ranges Key is a prefix string used to filter the named ranges found in the Excel workbook.
The default value is set using the value of the related user preference. It is possible to use an empty
string in order to retrieve all named ranges.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
524 of ANSYS, Inc. and its subsidiaries and affiliates.
UnitSystemName

The name of the unit system used for the Analysis container.

Type string

Read Only No

Methods
AddFile

Adds a file to an MSExcelSetup entity by providing its FilePath. The method copies and registers the
file into the Workbench project and returns an MSExcelFile entity if successful. The method also creates
an MSExcelRange entity for each named range matching the ExcelSetup.NamedRangeKey prefix string
("" by default). If the file does not exist, is not an Excel file or cannot be registered into the project, the
method throws an exception. If a file was already added to the MSExcelSetup, the method throws an
exception as well because only one file can be handled in each Analysis container. To use another file,
the user has to Reset the data container first.

Return The DataReference of the added file.

Type DataReference

Required Arguments

FilePath The Path of the original Microsoft Office Excel file to add.

Type string

Example
The following example shows how to add a file to the MSExcelSetup entity.

system1 = GetSystem(Name="XLS")
analysis1 = system1.GetContainer(ComponentName="Analysis")
setup1 = analysis1.GetExcelSetup()
file = setup1.AddFile(FilePath="C:\Test\ProcessCalculation.xlsx")
write file.FileName
ranges = file.GetRanges()

DeleteFile

Deletes a file from an MSExcelSetup entity and from the Workbench project file management. All the
MSExcelRange entities and associated Parameter entities are deleted as well.

Required Arguments

File The DataReference of the MSExcelFile entity to be deleted.

Type DataReference

Example
The following example shows how to delete a file from an MSExcelSetup entity.

system1 = GetSystem(Name="XLS")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 525
Microsoft Office Excel Analysis

analysis1 = system1.GetContainer(ComponentName="Analysis")
setup1 = analysis1.GetExcelSetup()
file = setup1.GetFile()
setup1.DeleteFile(file)

GetFile

Gets the MSExcelFile entity associated to the MSExcelSetup entity. If the MSExcelSetup entity has no
file, the method returns null. If the optional argument Name is specified but does not correspond to a
file associated to the MSExcelSetup, the method throws an exception.

Return The DataReference of the retrieved file entity.

Type DataReference

Optional Arguments

Name Name of the MSExcelFile entity to retrieve.

Type string

Example
The following example shows how the user can get a file entity from a setup entity to retrieve one of its
properties.

system1 = GetSystem(Name="XLS")
analysis1 = system1.GetContainer(ComponentName="Analysis")
setup1 = analysis1.GetExcelSetup()
file1 = setup1.GetFile()
write file1.Name

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
526 of ANSYS, Inc. and its subsidiaries and affiliates.
Parameters

Parameters
This container hold project-level Parameters and Design Points.

Methods
GetAllNamedExpressions
Returns all named expressions associated with a given container.

Return Named expressions in the given container.

Type DataReferenceSet

GetAllParameters
Returns the set of all parameters associated with all entity properties in a given container. Parameters
not associated with containers are not returned.

Return The set of parameters present in the given container.

Type DataReferenceSet

Example
In this example 'paramSet' becomes the set of parameters associated with the properties of any entity that
resides within the Results container of system1.

results1 = system1.GetContainer(ComponentName="Results")
paramSet = results1.GetAllParameters()

Data Entities
DesignPoint
The data entity which describes a project-level design point.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 527
Parameters

Read Only No

Exported

Specifies whether the design point is exported.

Type bool

Read Only No

HasValidRetainedData

Indicates whether the data model and files for this design point is retained in the project and valid.
This can happen for a retained DP; or a non-retained DP before previously retained data is deleted.

Type bool

Read Only Yes

IsUpToDate

True if the whole project is up to date for this design point.

Type bool

Read Only Yes

Note

Contains user-defined notes about the design point.

Type string

Read Only No

Retained

Gets or sets whether the design point is retained.

Type bool

Read Only No

UpdateOrder

The update order of the design point.

Type double

Read Only No

Methods
AreParameterValuesEqual

Comparison to see if all parameter values within two different design points are equivalent.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
528 of ANSYS, Inc. and its subsidiaries and affiliates.
Return True if all parameter values are equal.

Type bool

Required Arguments

DesignPoint2 The second design point

Type DataReference

CopyParameterExpressions

Copies all input parameter expressions from one design point to another.

Invalidates all output parameter values in the desination design point.

Required Arguments

ToDesignPoint The destination design point.

Type DataReference

Delete

Deletes a design point, the associated directory, and all design point files from the project.

Note that the active design point cannot be deleted.

Duplicate

Creates a new design point in which all parameters have the same values as in the specified original
design point.

Return The created design point entity.

Type DataReference

GetParameterValue

Returns the value of a specified parameter in a given design point.

Return The value of the parameter in the specified design point.

Type Object

Required Arguments

Parameter The parameter data reference.

Type DataReference

SetParameterExpression

Sets the expression of the specified input parameter in the given design point.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 529
Parameters

Required Arguments

Expression The string with the expression for the parameter.

Type string

Parameter The input parameter data reference.

Type DataReference

Example
The following example illustrates the setting of a parameter expression for a given design point.

dp = Parameters.GetDesignPoint("0")
param = Parameters.GetParameter("P1")
dp.SetParameterExpression(param, "cos(1)")

SetParameterExpressions

Sets expressions of the specified parameters in the specified design point.

Required Arguments

ParameterExpressions The parameters and expressions

Type IDictionary<DataReference, string>

Parameter
The data entity which describes a project-level Parameter.

Properties
Description

A human-readable description of the parameter.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ErrorMessage

An error message as a result of a validation or expression evaluation error.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
530 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only Yes

Expression

The parameter definition as an expression. This property may be a constant expression, or it may depend
on the values of other parameters.

Type string

Read Only No

ExpressionType

Indicates whether the expression is constant, derived from another expression, or undefined.

Type ExpressionType

Read Only Yes

Usage

Specifies how the paramter is used in the data model.

Type ParameterUsage

Read Only Yes

Value

The current value of the parameter. For derived parameters, this value is the evaluated expression result.

Type Object

Read Only Yes

ValueQuantityName

Gets the value quantity name if ValueSpec is a QuantitySpec. Null otherwise.

Type string

Read Only No

Methods
Delete

Deletes a parameter.

A parameter can only be deleted when it is no longer associated with any properties/entities in the
project.

Disassociate

Disassociates a data model property from an existing parameter.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 531
Parameters

To associate the parameter with a property, call AssociateParameter.

Required Arguments

Entity The data model entity that holds the property to be disassociated.

Type DataReference

PropertyName The name of the property to be disassociated.

Type string

DisassociateInContext

Disassociates a data model property for a given context from an existing parameter.

To associate the parameter with a property in context, call AssociateParameterInContext.

Required Arguments

Entity The data model entity that holds the property to be disassociated.

Type DataReference

PropertyName The name of the property to be disassociated.

Type string

Optional Arguments

Context The context of the association.

Type DataReference

Example
The following example illustrates proper DisassociateParameterInContext invocation:

entity1 = ...
parameter1 = Parameters.GetParameter(Name="p1")
parameter1.DisassociateParameterInContext(entity1, "SampleProperty")

Callers may provide a Context argument.

contextEntity1 = ...
parameter1.DisassociateParameterInContext(entity1, "SampleProperty", contextEntity1)

GetAssociatedEntityProperties

Returns the entity properties associated with a given parameter. If a container is specified, returns only
the entity properties for the given container.

Return A ParameterizedEntityPropertiesCollection dictionary containing a data

reference to each entity with parameterized properties and the list of
property names within that entity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
532 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type ParameterizedEntityPropertiesCollection

Optional Arguments

Container Optionally specifies a container for which the entity properties should be returned.

Type DataContainerReference

GetDependencies

For a derived parameter, returns the list of parameters referred to by this parameter's expression.

Return Data references to the parameters that this parameter is dependent upon.

Type List<DataReference>

SetQuantityName

Sets a parameter's quantity name.

Required Arguments

QuantityName The quantity name.

Type string

SetQuantityUnit

Set the unit string for a parameter across all design points.

Required Arguments

Unit The new units of the parameter.

Type string

ParameterSummaryChart
This is a summary chart that will display all parameters against all design points. This is useful for un-
derstanding and visualizing the full parameter space, but is not very useful for comparing one parameter
against another. For parameter vs. parameter charts, see CreateParameterVsParameterChart.

Properties
Chart

This stores the data reference to any generated charts from the Graphics system. e.g. a result of Cre-
ateMultiAxisChart.

Type DataReference

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 533
Parameters

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsBaseDesignPointExcluded

If this property is set the base design point will be excluded.

Type bool

Read Only No

Variables

The variables that have been added to the chart.

Type DataReferenceSet

Read Only No

Methods
Delete

Deletes a parameter chart.

ParameterVsParameterChart
This chart type can be used to plot one parameter against another or parameters vs. design points.

There are 4 accessable axes, X-Top, X-Bottom, Y-Left and Y-Right.

chart1 = Parameters.CreateParameterVsParameterChart()
chart1.XAxisBottom = Parameters.GetParameter("P1")
chart1.XAxisTop = Parameters.GetParameter("P2")
chart1.YAxisLeft = Parameters.GetParameter("P3")
chart1.YAxisRight = Parameters.GetParameter("P4")

Properties
Chart

This stores the data reference to any generated charts from the Graphics system. e.g. a result of Creat-
eChartXY.

Type DataReference

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
534 of ANSYS, Inc. and its subsidiaries and affiliates.
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsBaseDesignPointExcluded

If this property is set the base design point will be excluded.

Type bool

Read Only No

XAxisBottom

The parameter entity to be plotted on the primary (bottom) x-axis.

Type DataReference

Read Only No

XAxisTop

The parameter entity to be plotted on the secondary (top) x-axis.

Type DataReference

Read Only No

YAxisLeft

The parameter entity to be plotted on the left (primary) y-axis.

Type DataReference

Read Only No

YAxisRight

The parameter entity to be plotted on the right (secondary) y-axis.

Type DataReference

Read Only No

Methods
Delete

Deletes a parameter chart.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 535
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
536 of ANSYS, Inc. and its subsidiaries and affiliates.
Polyflow

Polyflow Setup
This container holds Setup data for an instance of Polyflow.

Methods
AddFile
Allows to import any kind of file into the Inputs sub-directory of the current Polyflow system

setup1.AddFile(FilePath="D:/temp/viscosity.crv")
This command will copy the viscosity.crv file from the D:\temp directory
into the Inputs directory of the current Polyflow system.

Required Arguments

FilePath Input : Path of file to be added.

Type string

Edit
Starts the editor (Polydata) given a Polyflow Setup Container

setup1.Edit()
This command will launch the editor (Polydata) of the selected Setup cell.

Exit
Stops the editor (Polydata) or the solver (Polyflow) given a Polyflow Setup or Solution Container

setup1.Exit()
This command will stop the editor (Polydata) of the selected Setup cell.

solver1.Exit()
This command will stop the solver (Polyflow) of the selected Solution cell.

GetPolyflowMesh
Returns the PolyflowMesh object stored in the Polyflow Setup component.

Return The PolyflowMesh object stored in the Polyflow Setup component.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 537
Polyflow

ImportMesh
Allows to import a mesh file (gambit *.neu file, *.poly file, *.msh Fluent Mesh file or Polyflow Mesh file).
For *.neu and¨*.poly and a *.msh fluent file, a mesh conversion is automatically performed to get
eventually a Polyflow Mesh file (*.msh)

setup1.ImportMesh(FilePath="D:/temp/swell.msh")
This command will copy the swell.msh file from the D:\temp directory
into the directory of the current Polyflow system.

Required Arguments

FilePath Input : path of mesh file to be imported (*.neu, *.poly or *.msh)

Type string

ImportSetup
Allows to import a setup file (*.dat file) into the current Polyflow system

setup1.ImportSetup(FilePath="D:/temp/swell.dat")
This command will copy the swell.dat file from the D:/temp directory
into the directory of the current Polyflow system.

Required Arguments

FilePath Input : Path of Polyflow setup file to be imported.

Type string

ImportUDF
Allows to import the udf file into the Inputs sub-directory of the current Polyflow system

setup1.ImportUDF(UdfFilePath="D:/temp/swell.udf")
This command will copy the swell.udf file from the D:/temp directory
into the Inputs directory of the current Polyflow system.

Required Arguments

UdfFilePath Input : Path of Polyflow udf file to be imported

Type string

SetMeshPreferences
Allows to specify which mesh of upstream polyflow system will be used in the current polyflow system
: one does not provide a mesh file name, but a specific key to the corresponding mesh. The Mesh restart
mode can take two values : "NoUpstreamMeshFile" or "SingleMeshFile"

setup1.SetMeshPreferences(
meshRestartMode="SingleMeshFile",
meshKey="mesh (t=0.5000000E+00)[formatted]"))
This command will take the mesh generated by the upstream polyflow system
at time t=0.5 (and that is formatted)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
538 of ANSYS, Inc. and its subsidiaries and affiliates.
Note : the mesh keys can be found in the "last_result.pub" file generated by the Polyflow solver in the
upstream system!

Required Arguments

meshKey Mesh key (among the list of available meshes created by an upstream polyflow system)

Type string

meshRestartMode Mesh restart mode

Type MeshRestartMode

StartFuseTool
Starts Polyfuse given a Polyflow Setup Container

setup1.StartFuseTool()
This command will launch the mesh manipulation tool (Polyfuse) on the selected Setup cell.

StartMaterialsTool
Starts Polymat given a Polyflow Setup Container

setup1.StartMaterialsTool()
This command will launch the material parameters fitting tool (Polymat) on the selected Setup cell.

StartPreferences
Starts the Editor of Polydata preferences given a Polyflow Setup Container or Starts the Editor of Polyflow
preferences given a Polyflow Solution Container

This command applies to Setup and Solution cells.

setup1.StartPreferences()
This command will launch the Preferences setting tool (Polypref) of the selected Setup cell.
solution1.StartPreferences()
This command will launch the Preferences setting tool (Polypref) of the selected Solution cell.

Data Entities
PolydataPreference
Contains a reference to the preferences file for Polydata (setup editor). It is a provider of the preferences
file.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 539
Polyflow

File

Data reference to the preferences file for Polydata.

Type DataReference

Read Only No

PolyflowMesh
Contains a reference to a Polyflow mesh file. It is a provider for a Polyflow mesh file.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

File

Data reference to the mesh file

Type DataReference

Read Only No

MeshReadingMode

Tells if one wants a conversion of the input mesh (*.poly or fluent *.msh) into a polyflow *.msh or if
one wants a direct reading by polydata (when editing setup)

Type MeshReading

Read Only No

PolyflowSetup
Contains a reference to a Polyflow data file. It is a provider of the data file (containing the setup).

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
540 of ANSYS, Inc. and its subsidiaries and affiliates.
File

Data reference to the Polyflow Dat file

Type DataReference

Read Only No

Polyflow Solution
This container holds Solution data for an instance of Polyflow.

Methods
ClearTemporaryFiles
Clear temporary files generated by Polyflow solver (if the solver is not running!) given a Polyflow Solution
Container

solution1.ClearTemporaryFiles()

Exit
Stops the editor (Polydata) or the solver (Polyflow) given a Polyflow Setup or Solution Container

setup1.Exit()
This command will stop the editor (Polydata) of the selected Setup cell.

solver1.Exit()
This command will stop the solver (Polyflow) of the selected Solution cell.

GetComponentSettingsForRsmDpUpdate
This query is used to obtain the ComponentSettingsForRsmDpUpdate object for Journaling and
Scripting

GetPolyflowSolution
Returns the PolyflowSolution object stored in the Polyflow Solution component.

Return The PolyflowSolution object stored in the Polyflow Solution component.

Type DataReference

GetSolutionSettings
This query is used to obtain the solution settings object for Journaling and Scripting

SetResultsPreferences
Allows to specify which result (res/rst/csv) of upstream polyflow system will be used in the current
polyflow system : one does not provide filenames, but specific keys to the corresponding result files.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 541
Polyflow

The solver restart mode can take the following values:

"No initialization from upstream system",

"Restart with a single Polyflow results file",
"Restart with Polyflow results and restart files",
"Restart with a single Polyflow CSV file",
"Restart with Polyflow CSV and restart files",
"Restart with a list of Polyflow results files (for transient mixing tasks only!)",
"Restart with a list of Polyflow CSV files (for conversion of a list of Polyflow CSV files)"

Note : the result (res,rst,csv) keys can be found in the "last_result.pub" file generated by the Polyflow
solver in the upstream system!

Required Arguments

csvKey Csv key (among the list of available csv created by an upstream polyflow system)

Type string

restartKey Restart key (among the list of available restart created by an upstream polyflow
system)

Type string

resultKey Result key (among the list of available results created by an upstream polyflow
system)

Type string

solverRestartMode Solver restart mode

Type SolverRestartMode

Example

solution1.SetResultsPreferences(
solverRestartMode="Restart with a single Polyflow CSV file",
resultKey="undefined",
restartKey="undefined",
csvKey="csv (t=0.5000000E+00)[formatted]")

This command will take the csv generated by the upstream polyflow system at time t=0.5 (and that
is formatted)

StartCurveTool
Starts Polycurve (curves viewer) given a Polyflow Solution Container

solution1.StartCurveTool()
This command will launch Polycurve of the selected Solution cell.

StartDiagnosticsTool
Starts Diagnostics tool (Polydiag) given a Polyflow Solution Container

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
542 of ANSYS, Inc. and its subsidiaries and affiliates.
 solution1.StartDiagnosticsTool()
This command will launch the Diagnostics tool (Polydiag) of the selected Solution cell.

StartListingViewer
Starts the listing viewer given a Polyflow Solution Container

solution1.StartListingViewer()
This command will launch the listing viewer tool (Polylst) on the selected Solution cell.

StartPreferences
Starts the Editor of Polydata preferences given a Polyflow Setup Container or Starts the Editor of Polyflow
preferences given a Polyflow Solution Container

This command applies to Setup and Solution cells.

setup1.StartPreferences()
This command will launch the Preferences setting tool (Polypref) of the selected Setup cell.
solution1.StartPreferences()
This command will launch the Preferences setting tool (Polypref) of the selected Solution cell.

StartStatisticsTool
Starts Polystat given a Polyflow Solution Container

solution1.StartStatisticsTool()
This command will launch the statistical analyzer tool (Polystat) on the selected Solution cell.

SwitchToBackgroundMode
Switch the Update in progress into background mode. This will enable operations that are not allowed
during an Update in foreground mode (e.g. Project Save).

This command is not normally useful in a script. Journals may record the invocation of this command
after an Update invoke, as the result of GUI activity while the Update is in progress. However, replay of
these journals will always wait for the Update invoke to complete before invoking the next command,
rendering this step ineffectual.

Data Entities
PolyflowPreference
Contains a reference to the preferences file for Polyflow (solver). It is a provider of the preferences file.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 543
Polyflow

File

Data reference to the preferences file for Polyflow.

Type DataReference

Read Only No

PolyflowSolution
Contains a reference to a Polyflow listing file. It is a provider of the listing file (containing a summary
of the simulation).

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

File

Data reference to the listing file generated by the Polyflow solver and containing a summary of the
simulation.

Type DataReference

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
544 of ANSYS, Inc. and its subsidiaries and affiliates.
Project

Project
This container holds the Systems, Components and Templates in the project.

Data Entities
Component
Data entity representing a component of a system in the schematic.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Notes

A note about the component.

Type string

Read Only No

Methods
Clean

Delete the heavyweight data (e.g. solution and/or results) of this component to reduce the size of the
project.

DeleteShare

Removes all sharing affecting the specified component.

Optional Arguments

System The target system holding the shared component. Used if the component is shared in more than
one system.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 545
Project

Type DataReference

DeleteTransfer

Deletes the transfer connection between two components.

Required Arguments

TargetComponent A reference to the component that was receiving data.

Type DataReference

GetContainer

Query to return the Container for the component.

Return Container Reference

Type DataContainerReference

GetTaskObject

This method is available only in AIM. For the given project schematic component, return it's anchor
object.

Return The anchor object associated with the project schematic component.

Type DataReference

Refresh

Refreshes the input data for a component by reading all changed data from upstream (source) compon-
ents. Does not perform any calculations or updates based on the new data.

RemoveFromSystem

Deletes the component and all dependents from a system.

Required Arguments

System A reference to the system containing the component to be deleted. This is needed in case the
component is shared between more than one system.

Type DataReference

ReplaceWithShare

Replaces a component in a system with a shared copy of a component from another system. The data
sources of any downstream components are updated to include the new component.

Required Arguments

ComponentToShare The component to share into the target system.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
546 of ANSYS, Inc. and its subsidiaries and affiliates.
Optional Arguments

SourceSystem The system from which to share the specified component.

Type DataReference

TargetSystem The target system into which to share the component.

Type DataReference

Example
The following example illustrates a replace of a component with a shared copy of another system's com-
ponent.

componentToShare = sys2.GetComponent("componentName")
componentToReplace = sys1.GetComponent("componentName")
componentToReplace.ReplaceWithShare(ComponentToShare=componentToShare)

Note that you do not need to specify the TargetSystem and SourceSystem. They are only retained
for legacy compatibility.

Reset

Resets the component by removing all user input and result data.

TransferData

Creates a data transfer connection between two components in the project.

Required Arguments

TargetComponent A reference to the component receiving data.

Type DataReference

TransferSpecificData

Create a data transfer connection between two existing components, specifying the type of data to be
transferred. This is used in some situations where more than one type of data can be exchanged between
two components.

See also component.TransferData(TargetComponent=...)

Required Arguments

TargetComponent A reference to the component receiving data.

Type DataReference

TransferDataName The name of the type of data to be transferred between components.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 547
Project

Update

Updates the component by refreshing the input from all upstream components and then performs a
local calculation based on current data.

Optional Arguments

AllDependencies If true, also updates all upstream dependencies of this component.

Type bool

UpdateUpstreamComponents

Updates all components upstream of the given component, without updating the component itself.

ComponentTemplate
This entity provides information used in the creation of a new component in the project. A component
template has no user modifiable properties and is typically only referenced when creating a new system
that includes data connections.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Methods
CreateComponent

Creates a component based on a given component template.

Required Arguments

System The system to which the created component should be added.

Type DataReference

Optional Arguments

AllSystemProperties The system properties to provide to the container creation command.

Type SystemPropertyDictionary

CreatedComponent The created component.

Type Output<DataReference>

Name The name to use for the created component.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
548 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

UpstreamComponent A list of upstream components which will provide transfer data to the created
component.

Type List<DataReference>

Example
The following example illustrates Component creation from a template.

system1 = CreateSystem(...)
template = GetComponentTemplate("MyTemplate")
template.CreateComponent(System=system1)

Optional properties allow you to modify component creation, including the establishment of upstream
component connections.

system1 = CreateSystem(...)
upstreamComponent = ...
template = GetComponentTemplate("MyTemplate")
template.CreateComponent(Name="MyComponent", System=system1, UpsatreamComponent=[upstreamComponent], AllSys

CustomProjectTemplate
A project snippet template containing multiple systems and their links.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

SystemNames

The names of the systems to create, one for each entry in the SystemTemplates list.

Type List<string>

Read Only No

SystemTemplates

Templates for the systems making up this snippet.

Type List<DataReference>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 549
Project

Methods
CreateProject

Instantiates all the systems contained in a project snippet template.

Delete

Deletes the project template from the toolbox and user's Workbench application data.

SchematicSettings
This data entity holds properties that control the appearance of the Project Schematic.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Notes

A note about the project.

Type string

Read Only No

System
A collection of components brought together to complete a specific type of analysis or data generation
within a project.

Properties
AnalysisType

The analysis type associated with this system.

Type string

Read Only No

Components

The set of components which form this system.

Type List<DataReference>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
550 of ANSYS, Inc. and its subsidiaries and affiliates.
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Notes

A note about the system.

Type string

Read Only No

Physics

The physics associated with this system.

Type List<string>

Read Only No

Solver

The solver associated with this system.

Type List<string>

Read Only Yes

Methods
CloseAnsoftApplication

Closes the editor opened for the supplied system. This is a no-operation, if no editor is opened.

Optional Arguments

SaveBeforeClose Optional parameter which controls whether the system state is saved before the ap-
plication close. This is currently ignored and is effectively "true" for all invocations.

Type bool

Delete

Deletes the system and all contained data from the project.

Duplicate

Creates a new system containing a copy of all the data in this system.

Return The reference to the created system.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 551
Project

Type DataReference

Optional Arguments

ComponentsToShare The components to share into the new system. Used if the system being duplicated
has shared components, and we wish to continue using those shares in the new
system.

Type List<DataReference>

Name The name for the new system.

Type string

Position Type of positioning of the new system.

Type PositionType

RelativeTo The system to which new system is positioned relative to.

Type DataReference

Example
The following example illustrates System duplication. No components are shared. The new, copied system
will appear to the right of the existing system. Its name will be "MyNewSystme".

mySystem = CreateSystem(...)
mySystem2 = mySystem.Duplicate(ComponentsToShare=[],
Position="Right",
RelativeTo=mySystem,
Name="MyNewSystem")

GetComponent

Query to return the component reference for a given component base name in the system.

Return Data Container Reference

Type DataReference

Required Arguments

Name The Name of Component derived form its Base Name.

Type string

GetContainer

Query to return the container for a given component base name in the system.

Return Data Container Reference

Type DataContainerReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
552 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

ComponentName Base Name of the Component

Type string

GetReplaceableTemplates

A query to return the list of templates that can be used to replace the current system.

See also template.ReplaceSystem(System=...).

Return The list of System Template references that can be used to replace this system.

Type List<DataReference>

Move

Moves an existing system in the schematic.

Required Arguments

Position Type of positioning.

Type PositionType

RelativeTo The system that the moved system is positioned relative to.

Type DataReference

RecreateDeletedComponents

Recreates new versions of any components that have been deleted from the system.

Refresh

Refreshes the input data for all components in the system by reading changed data from upstream
sources. Does not perform any calculations or updates based on the new data.

SendAnsoftCommand

Send a Visual Basic command string or a script file understood by the Ansoft applications to the editor
associated with the system. Only one of the "Command" or "CommandFile" arguments can be specified.

Return The return value from the command. This is only supported when using
Python single-line arguments - if PyCommand is used, the command's
output is returned - all others, the empty string is returned.

Type Object

Optional Arguments

Command Single line VB Command string

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 553
Project

CommandFile File containing VB script commands that can also be directly executed from the application's
Tools->Run Script

Type string

PyCommand Single line Python command string.

Type string

Example
Required example does not exist.

Update

Updates all components in the system by refreshing the input from all upstream sources, and then
performing local calculation based on current data.

Optional Arguments

AllDependencies If true, also updates all upstream dependencies of this system.

Type bool

Template
A template that is used to create a system within the project.

Properties
AnalysisType

The analysis type assocated with this system template.

Type string

Read Only No

DisplayName

The user-visible name for the type of systems created from this template.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
554 of ANSYS, Inc. and its subsidiaries and affiliates.
Physics

The physics assocated with this system template.

Type List<string>

Read Only No

Solver

The solver assocated with this system template.

Type List<string>

Read Only Yes

SystemType

The system type, displayed in the User Interface in the header of the system block.

Type string

Read Only No

SystemTypeAbbreviation

The system type abbreviation, used to create the system unique directory name and also serves as the
system object's base name.

Type string

Read Only No

Methods
CreateSystem

Creates a new system from a system template.

Return The reference to the created system.

Type DataReference

Optional Arguments

ComponentsToShare A list of components to share into the newly created system.

Type List<DataReference>

DataTransferFrom A list of data transfer specifications to transfer data into the new system. This is used
to create follow-on systems. This and DataTransferTo are mutually exclusive.

Type List<TransferDataToNewComponentSpec>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 555
Project

DataTransferTo A list of data transfer specifications to transfer data from the new system into existing
components. This is used to create a preceding system. This and DataTransferFrom
are mutually exclusive.

Type List<TransferDataFromNewComponentSpec>

Name The name for the new system.

Type string

Position Type of positioning of the new system.

Type PositionType

Default Value Default

RelativeTo The system to which new system is positioned relative to.

Type DataReference

Example
Two examples are presented. This first section gets the template for a "Fluid Flow (CFX)" system, and then
creates an empty, stand-alone system in the default position.

template1 = GetTemplate(TemplateName="Fluid Flow", Solver="CFX")

system1 = template1.CreateSystem()

In the second part of the example, we create a Static Structural (ANSYS) system connected to the
previous Fluid Flow system. The Geometry component from the Fluid Flow system (component1)
is shared with the new Static Structural system. The Solution component from the Fluid Flow system
(component2) transfers results data into the Setup component of the Static Structural system. The
new system is created to the right of the existing system.

template2 = GetTemplate(TemplateName="Static Structural", Solver="ANSYS")

component1 = system1.GetComponent(Name="Geometry")
component2 = system1.GetComponent(Name="Solution")
componentTemplate1 = GetComponentTemplate(Name="SimulationSetupTemplate_StructuralStaticANSYS")
system2 = template2.CreateSystem(
CellsToShare=[component1],
DataTransferFrom=[{"FromComponent": component2,
"TransferName": "CFXTransferResultsTemplate",
"ToComponentTemplate": componentTemplate1}],
Position="Right",
RelativeTo=system1)

ReplaceSystem

Replace an existing system with one based on the selected System Template.

There are a number of restrictions on the template that can be used to replace an existing system. See
system.GetReplaceableTemplates() to determine the list of allowable templates.

Return The reference to the created system.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
556 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

System The existing system to replace.

Type DataReference

Optional Arguments

Name The name for the new system.

Type string

Project File Types

This container holds File Types registered with the File Manager.

Data Entities
FileType
FileType defines file type information including a short description.

Properties
Description

The description of the file type.

Type string

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ExtensionPatterns

The possible file extension patterns to match in a regular expression. The patterns are used to check
whether this file type can handle a set of file extensions.

Type List<string>

Read Only Yes

Extensions

The possible file extensions (with the leading "."). These extensions can be displayed to the user in a
file dialog filter, for example.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 557
Project

Type List<string>

Read Only Yes

Project Files
This container holds Files registered with the File Manager.

Methods
GetFiles
Gets all the File References that are associated with the specified container.

Return The set of file references associated with the container.

Type DataReferenceSet

Example
This example prints the location of files for two different components of a system.

system1 = GetSystem(Name="Static1")
geometry1 = system1.GetContainer(ComponentName="Geometry")
for fileRef in geometry1.GetFiles():
print fileRef.Location
>>> C:\Users\myUser\Projects\static1_files\dp0\SYS\DM\SYS.agdb
>>> E:\data\Models\pipe.x_t
model1 = system1.GetContainer(ComponentName="Model")
for fileRef in model1.GetFiles():
print fileRef.Location
>>> C:\Users\myUser\Projects\static1_files\dp0\global\MECH\SYS.engd
>>> C:\Users\myUser\Projects\static1_files\dp0\global\MECH\SYS.mechdb

Data Entities
FileReference
The data entity that represents a file that is part of the project.

Properties
Directory

A string that contains the path to the directory containing the file.

Type string

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
558 of ANSYS, Inc. and its subsidiaries and affiliates.
Type string

Read Only No

Exists

A value indicating whether the file exists.

Type bool

Read Only Yes

FileName

The name of the file, including the extension.

Type string

Read Only Yes

LastModifiedTime

The time at which this file was most recently modified.

Type DateTime

Read Only Yes

Location

The full path to the local file including the directory and file name.

Type string

Read Only No

Size

The size of the file in bytes.

Type long

Read Only Yes

Methods
Copy

Copies a file to a target directory.

Return A reference to the created file is returned in this argument.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 559
Project

Required Arguments

DestinationDirectoryPath The full path to the destination directory.

Type string

Overwrite Specifies whether to overwrite an existing files of the same name. Note:
A registered file may not be overwritten.

Type bool

Example
The following example illustrates proper CopyFileByReference command invocation:

fileRef = GetRegisteredFileQuery(FilePath=r"path_to_file")
fileRefCopy = fileRef.Copy(DestinationDirectoryPath=r"path_to_copy_file", Overwrite=True, CopyReferenceCoun

Delete

Deletes the specified file

Optional Arguments

BackUp Specifies whether to back up the file before deletion. This optional argument's default
value is true.

Type bool

Default Value True

DeleteIfShared Specifies whether a registered file should be deleted even if it is still in use. This optional
argument's default value is true. If this argument's value is false, an exception will be
thrown if a shared file is encountered. To avoid the exception, set ErrorIfShared to false.

Type bool

Default Value False

ErrorIfShared Specifies whether to throw an exception when trying to delete a shared file if DeleteIf-
Shared is set to false.

Type bool

Example
The following example illustrates a deletion of a registered file via a file reference. The file will be deleted
if even if it is still in use. Note that the file will be backed up.

fileRef = GetRegisteredFile(FilePath=r"C:\Users\anyuser\path-to-file.extension")
fileRef.Delete(DeleteIfShared=True,
BackUp=True)

The next example illustrates a deletion of a registered file via a file reference without a forced dele-
tion. If the file is shared, an error will not occur, and the file reference count will be decremented.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
560 of ANSYS, Inc. and its subsidiaries and affiliates.
 fileRef = GetRegisteredFile(FilePath=r"C:\Users\anyuser\path-to-file.extension")
fileRef.Delete(ErrorIfShared=False)

Move

Moves a file to a new directory.

Required Arguments

NewDirectoryPath The full path to the destination directory.

Type string

Optional Arguments

BackUp Specifies whether to back up the file before the move. This optional argument's default value is
true.

Type bool

Default Value True

Example
The following example illustrates proper MoveFileByReference command invocation:

fileRef = GetRegisteredFileQuery(FilePath=r"path_to_file")
fileRefCopy = fileRef.Move(NewDirectoryPath=r"path_to_move_file", Backup=False)

Rename

Renames a file.

Required Arguments

New- The new file name, excluding the directory path. To change the directory, see MoveFileCommand.
Name
Type string

Optional Arguments

BackUp Specifies whether to back up the file before renaming it. This optional argument's default value is
true.

Type bool

Default Value True

Example
The following example illustrates proper RenameFileByReference command invocation:

fileRef = GetRegisteredFileQuery(FilePath=r"path_to_file")
fileRefCopy = fileRef.Rename(NeName="new_file_name", BackUp=True)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 561
Project

Repair

Repairs a file that is referenced in the project but cannot be found on disk. If the file is expected to be
found under the project directory, then this command will copy the new file to the expected location
rather than link to the new file in its current location. Use SetFilePathCommand to link to a file in a new
location.

Required Arguments

FilePath A full path to the file in its updated location.

Type string

RepositoryFileSource
RepositoryFileSourceEntity defines repository file information including a server, workspace and filepath

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FileName

The name of the file, including the extension.

Type string

Read Only Yes

IsMissingInRepository

A value indicating whether the file exists on repository server

Type bool

Read Only No

LastDownloadRepositoryModificationTime

Modifed time stamp of file at the download time

Type DateTime

Read Only No

LastDownloadTime

Last downloaded time from repostiroy server

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
562 of ANSYS, Inc. and its subsidiaries and affiliates.
Type long

Read Only No

LocalFileExists

A value indicating whether the local file exists.

Type bool

Read Only Yes

LocalLocation

String representation of local path to specify the local copy of repository file

Type string

Read Only No

Size

The size of the local file in bytes.

Type long

Read Only Yes

SourceFileInfo

Repository file info holder of

Type RepositoryFileInfo

Read Only No

Project Messages
This container holds current project messages.

Data Entities
StoredMessage
A data entity representing a message (error, warning, information, etc.) that is visible to the user.

Properties
Association

The data model entity to which the message applies (a component, for example).

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 563
Project

Read Only Yes

DateTimeStamp

The publication time.

Type DateTime

Read Only Yes

Details

The detailed text string of the message.

Type string

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

MessageType

The type of the message (e.g., Information, Warning, Error, etc.).

Type MessageType

Read Only Yes

Summary

The summary text string of the message.

Type string

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
564 of ANSYS, Inc. and its subsidiaries and affiliates.
Study

Study
This container holds Study data for an instance of Study.

Common Methods
CreateDataManager
The Data Manager is a utility object intended for use by the ImportEngineeringData command. It is
used to load an applicable manager for the type of data being managed as well the source of the data
which the manager will use to bring the data into the project.

Return The newly created Data Manager DataReference.

Type DataReference

Optional Arguments

Provider The management provider for the requested Source of data. The provider understands how to
convert the data in the sources to AIM.

Type string

Default Value ANSYS

Sources The source of the data which will be managed by the Data Manager. If this argument is not
provided the Source must be set or provided before the Data Manager is used.

Type List<string>

Example
This example creates a Data Manager in the study.

dataManagerThermal = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\Thermal_Materials.xm
Provider="ANSYS")

CreateEntity
Create AIM objects of the requested Type.

Return An instance of the Type.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 565
Study

Required Arguments

Type The entity Type to create. The entity Type can be seen in the GUI by hovering over the entity's object
icon. Also using dir(Study) will show object types for Get<Type> queries, for which the <Type> may
be able to be created.

Type string

Optional Arguments

AssociatedObject The object to associate this object to in the AIM dependency graph, which
will create a directed edge in the AIM dependency graph. See discussion on
Study and Tasks. This is deprecated in favor of Association.

Type DataReference

Association The object to associate this object to in the AIM dependency graph, which
will create a directed edge in the AIM dependency graph. See discussion on
Study and Tasks.

Type DataReference

Location If the entity has a location property, this will set the property to the provided
LocationSet.

Type Object

Default Value Ansys.Study.Core.Common.Referencing.LocationSet

Location2 If the entity has a second location property, this will set the property to the
provided LocationSet.

Type Object

Default Value Ansys.Study.Core.Common.Referencing.LocationSet

LocationWithHitPoints If the entity has a location property with hit points, this will set the property
to the provided LocationSet.

Type Object

Default Value Ansys.Study.Core.Common.Referencing.LocationSet

LocationWithHitPoints2 If the entity has a second location property with hit points, this will set the
property to the provided LocationSet.

Type Object

Default Value Ansys.Study.Core.Common.Referencing.LocationSet

ObjectReferences Future use

Type DataReferenceSet

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
566 of ANSYS, Inc. and its subsidiaries and affiliates.
Example

This example shows the steps preceding the CreateEntity, and then creates a PhysicsRegion object.
system1 = GetSystem(Name="Study")
physicsDefinitionComponent1 = Study.CreateTask(
Type="Physics Definition",
System=system1)
study1 = system1.GetContainer(ComponentName="Study")
physicsDefinition1 = physicsDefinitionComponent1.GetTaskObject()
physicsRegion1 = study1.CreateEntity(
Type="PhysicsRegion",
Association=physicsDefinition1)

CreateTable
CreateTable is a convenience command which performs the following commands:

Creates a table and associates with the Parent. See the CreateEntity command, where
Type="Table" and AssociatedObject=Parent.
Adds columns corresponding to the Columns parameter. See the AddTableColumn command.

Return The DataReference of the newly created table.

Type DataReference

Required Arguments

Columns A List of tuple (name and physical quantity). The name is used to identify the column and must
be unique to this table. The physical quantity (e.g. Density, Pressure, etc.) is used to verify the data
has the correct units. The use of integer indexes in other table related commands correspond to
the order of the columns, with 0 (zero) being the first item.

Type List<List<string>>

Parent The DataReference of the object to which this table should be created in the scope of

Type DataReference

Example
This example illustrates creating a table and setting data in the table.

# drContainer is the DataContainerReference of an object that has been previously created (e.g. study1)
# drParent is the DataReference of an object that has been previously created (e.g. material1)
table1 = drContainer.CreateTable(drParent, Columns=[("Temperature","Temperature"),("Displacement","Length")
table1.AddRow(Data=["100 [C]","1.0 [m]"])
table1.AddRow(Data=["200 [C]",".02 [m]"])
table1.AddRow(Data=["300 [C]",".06 [m]"])
table1.GetData()

GetAFDPhysicsOptions
Obtains a AFDPhysicsOptions instance by name from the supplied container.

Return The AFDPhysicsOptions instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 567
Study

Required Arguments

Name The entity name for which to search.

Type string

GetBoundary
Obtains a Boundary instance by name from the supplied container.

Return The Boundary instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetBoundaryCondition
Obtains a BoundaryCondition instance by name from the supplied container.

Return The BoundaryCondition instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetCappingSurface
Obtains a CappingSurface instance by name from the supplied container.

Return The CappingSurface instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetConfiguration
Obtains a Configuration instance by name from the supplied container.

Return The Configuration instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
568 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The entity name for which to search.

Type string

GetConnection
Obtains a Connection instance by name from the supplied container.

Return The Connection instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetConnectionBehavior
Obtains a ConnectionBehavior instance by name from the supplied container.

Return The ConnectionBehavior instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetConstraint
Obtains a Constraint instance by name from the supplied container.

Return The Constraint instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetContactBehavior
Obtains a ContactBehavior instance by name from the supplied container.

Return The ContactBehavior instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 569
Study

Required Arguments

Name The entity name for which to search.

Type string

GetContourResult
Obtains a ContourResult instance by name from the supplied container.

Return The ContourResult instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetConvection
Obtains a Convection instance by name from the supplied container.

Return The Convection instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetCurrent
Obtains a Current instance by name from the supplied container.

Return The Current instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetDisplacement
Obtains a Displacement instance by name from the supplied container.

Return The Displacement instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
570 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The entity name for which to search.

Type string

GetEquipotential
Obtains a Equipotential instance by name from the supplied container.

Return The Equipotential instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetFluidBoundary
Obtains a FluidBoundary instance by name from the supplied container.

Return The FluidBoundary instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetForce
Obtains a Force instance by name from the supplied container.

Return The Force instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetGeometryImportSource
Obtains a GeometryImportSource instance by name from the supplied container.

Return The GeometryImportSource instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 571
Study

Required Arguments

Name The entity name for which to search.

Type string

GetHeatFlow
Obtains a HeatFlow instance by name from the supplied container.

Return The HeatFlow instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetHeatFlux
Obtains a HeatFlux instance by name from the supplied container.

Return The HeatFlux instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetHeatGeneration
Obtains a HeatGeneration instance by name from the supplied container.

Return The HeatGeneration instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetImport
Obtains a Import instance by name from the supplied container.

Return The Import instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
572 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The entity name for which to search.

Type string

GetInertiaLoad
Obtains a InertiaLoad instance by name from the supplied container.

Return The InertiaLoad instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetInitialConditions
Obtains a InitialConditions instance by name from the supplied container.

Return The InitialConditions instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetInterfaceGenerator
Obtains a InterfaceGenerator instance by name from the supplied container.

Return The InterfaceGenerator instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetIsoSurface
Obtains a IsoSurface instance by name from the supplied container.

Return The IsoSurface instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 573
Study

Required Arguments

Name The entity name for which to search.

Type string

GetLoad
Obtains a Load instance by name from the supplied container.

Return The Load instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetMaterial
Obtains a Material instance by name from the supplied container.

Return The Material instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetMaterialAssignment
Obtains a MaterialAssignment instance by name from the supplied container.

Return The MaterialAssignment instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetMechanicalPhysicsOptions
Obtains a MechanicalPhysicsOptions instance by name from the supplied container.

Return The MechanicalPhysicsOptions instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
574 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The entity name for which to search.

Type string

GetMesh
Obtains a Mesh instance by name from the supplied container.

Return The Mesh instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetMeshControl
Obtains a MeshControl instance by name from the supplied container.

Return The MeshControl instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetMeshControlBodySizing
Obtains a MeshControlBodySizing instance by name from the supplied container.

Return The MeshControlBodySizing instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetMeshControlEdgeSizing
Obtains a MeshControlEdgeSizing instance by name from the supplied container.

Return The MeshControlEdgeSizing instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 575
Study

Required Arguments

Name The entity name for which to search.

Type string

GetMeshControlElementShape
Obtains a MeshControlElementShape instance by name from the supplied container.

Return The MeshControlElementShape instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetMeshControlFaceSizing
Obtains a MeshControlFaceSizing instance by name from the supplied container.

Return The MeshControlFaceSizing instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetMeshControlLocalInflation
Obtains a MeshControlLocalInflation instance by name from the supplied container.

Return The MeshControlLocalInflation instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetMeshDiagnostics
Obtains a MeshDiagnostics instance by name from the supplied container.

Return The MeshDiagnostics instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
576 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The entity name for which to search.

Type string

GetMeshing
Obtains a Meshing instance by name from the supplied container.

Return The Meshing instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetMoment
Obtains a Moment instance by name from the supplied container.

Return The Moment instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetMoveRotateControl
Obtains a MoveRotateControl instance by name from the supplied container.

Return The MoveRotateControl instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetNumericalControls
Obtains a NumericalControls instance by name from the supplied container.

Return The NumericalControls instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 577
Study

Required Arguments

Name The entity name for which to search.

Type string

GetOutputControls
Obtains a OutputControls instance by name from the supplied container.

Return The OutputControls instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetPhysicsCoupling
Obtains a PhysicsCoupling instance by name from the supplied container.

Return The PhysicsCoupling instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetPhysicsDefinition
Obtains a PhysicsDefinition instance by name from the supplied container.

Return The PhysicsDefinition instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetPhysicsOptions
Obtains a PhysicsOptions instance by name from the supplied container.

Return The PhysicsOptions instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
578 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The entity name for which to search.

Type string

GetPhysicsRegion
Obtains a PhysicsRegion instance by name from the supplied container.

Return The PhysicsRegion instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetPhysicsRegionInterface
Obtains a PhysicsRegionInterface instance by name from the supplied container.

Return The PhysicsRegionInterface instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetPlane
Obtains a Plane instance by name from the supplied container.

Return The Plane instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetPoint
Obtains a Point instance by name from the supplied container.

Return The Point instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 579
Study

Required Arguments

Name The entity name for which to search.

Type string

GetPressure
Obtains a Pressure instance by name from the supplied container.

Return The Pressure instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetRadiation
Obtains a Radiation instance by name from the supplied container.

Return The Radiation instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetReferenceFrame
Obtains a ReferenceFrame instance by name from the supplied container.

Return The ReferenceFrame instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetResultObject
Obtains a ResultObject instance by name from the supplied container.

Return The ResultObject instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
580 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The entity name for which to search.

Type string

GetResults
Obtains a Results instance by name from the supplied container.

Return The Results instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetScalarConstraint
Obtains a ScalarConstraint instance by name from the supplied container.

Return The ScalarConstraint instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetScalarLoad
Obtains a ScalarLoad instance by name from the supplied container.

Return The ScalarLoad instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetSelectionSet
Obtains a SelectionSet instance by name from the supplied container.

Return The SelectionSet instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 581
Study

Required Arguments

Name The entity name for which to search.

Type string

GetSimulation
Obtains a Simulation instance by name from the supplied container.

Return The Simulation instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetSingleValueResult
Obtains a SingleValueResult instance by name from the supplied container.

Return The SingleValueResult instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetSolutionControls
Obtains a SolutionControls instance by name from the supplied container.

Return The SolutionControls instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetSolutionQualityMonitor
Obtains a SolutionQualityMonitor instance by name from the supplied container.

Return The SolutionQualityMonitor instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
582 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The entity name for which to search.

Type string

GetSolvePhysics
Obtains a SolvePhysics instance by name from the supplied container.

Return The SolvePhysics instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetSolverSettings
Obtains a SolverSettings instance by name from the supplied container.

Return The SolverSettings instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetStreamLine
Obtains a StreamLine instance by name from the supplied container.

Return The StreamLine instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetSupport
Obtains a Support instance by name from the supplied container.

Return The Support instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 583
Study

Required Arguments

Name The entity name for which to search.

Type string

GetSuppressControl
Obtains a SuppressControl instance by name from the supplied container.

Return The SuppressControl instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetTemperatureCondition
Obtains a TemperatureCondition instance by name from the supplied container.

Return The TemperatureCondition instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetTemperatureConstraint
Obtains a TemperatureConstraint instance by name from the supplied container.

Return The TemperatureConstraint instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetTranscript
Obtains a Transcript instance by name from the supplied container.

Return The Transcript instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
584 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The entity name for which to search.

Type string

GetUserCommands
Obtains a UserCommands instance by name from the supplied container.

Return The UserCommands instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetValidMaterialContent
Query to return a list of valid material model tuples, where each tuple has the strings for use on the
CreateMaterialContent command. The tuple is in the following form (Model, Definition, Behavior)

Return A list of the valid material model tuples. The default list returned is in the
following form [(Model, Definition, Behavior), ..., (Model, Definition, Beha-
vior)].

Type List<Object>

Optional Arguments

IncludeName Include the user friendly name as the first element of a sub-list and second element is the
material model tuple. The list returned is in the following form [[Name, (Model, Definition,
Behavior)], ..., [Name, (Model, Definition, Behavior)]]

Type bool

Default Value False

Example
This example requests all the valid material properties including the names.

validContent = Study.GetValidMaterialContent(IncludeName=true)

GetVectorConstraint
Obtains a VectorConstraint instance by name from the supplied container.

Return The VectorConstraint instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 585
Study

Required Arguments

Name The entity name for which to search.

Type string

GetVectorLoad
Obtains a VectorLoad instance by name from the supplied container.

Return The VectorLoad instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetVectorResult
Obtains a VectorResult instance by name from the supplied container.

Return The VectorResult instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetVirtualPrimitiveBox
Obtains a VirtualPrimitiveBox instance by name from the supplied container.

Return The VirtualPrimitiveBox instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetVoltage
Obtains a Voltage instance by name from the supplied container.

Return The Voltage instance.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
586 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The entity name for which to search.

Type string

GetVolumeExtractionRegion
Obtains a VolumeExtractionRegion instance by name from the supplied container.

Return The VolumeExtractionRegion instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetVolumeSimplificationRegion
Obtains a VolumeSimplificationRegion instance by name from the supplied container.

Return The VolumeSimplificationRegion instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

GetWrap
Obtains a Wrap instance by name from the supplied container.

Return The Wrap instance.

Type DataReference

Required Arguments

Name The entity name for which to search.

Type string

Common Data Entities

AxisDirectionDefinition
Defines an axis from a vector or point.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 587
Study

Properties
Automatic

Property to automatically compute the axis direction.

Type bool

Read Only No

Axis

Axis being defined.

Type AxisType

Read Only No

DefineBy

Option to define the axis.

Type AxisDefineBy

Read Only No

CappingSurface
A CappingSurface creates an analytic surface based on a set of bounding edges or faces.

Properties
CreateSelectionSet

Flag to enable/disable automatic selection set creation.

Type bool

Read Only No

SelectionMethod

Specifies the method used to create the Capping Surface.

Type CappingSurfaceConstructionMethod

Read Only No

CappingSurfaceEdgesConstraint
Provides additional information to a Capping Surface when it is constructed based on a set of edges.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
588 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Algorithm

The algorithm used to construct the capping surface.

Type ConstructionAlgorithm

Read Only No

Edges

The set of selected edges.

Type LocationSet

Read Only No

FlipLoopOrientation

Sets the orientation of the edge loop, if the algorithm is a Convex Hull.

Type ReverseEdgeLoopOrientation

Read Only No

CappingSurfaceFacesConstraint
Provides additional information to a Capping Surface when it is constructed based on the internal loops
of a set of faces.

Properties
Algorithm

The algorithm used to construct the capping surface.

Type ConstructionAlgorithm

Read Only No

Faces

The set of selected faces.

Type LocationSet

Read Only No

FlipLoopOrientation

Sets the orientation of the edge loop, if the algorithm is a Convex Hull.

Type ReverseEdgeLoopOrientation

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 589
Study

CappingSurfaceLoopsConstraint
Provides additional information to a Capping Surface when it is constructed based on a set of edge
loops.

Properties
Algorithm

The algorithm used to construct the capping surface.

Type ConstructionAlgorithm

Read Only No

EdgeLoopCount

Gets or sets edge loop count.

Type int

Read Only No

EdgeLoops

The set of selected edge loops.

Type List<LocationSet>

Read Only No

FlipLoopOrientation

Sets the orientation of the edge loop, if the algorithm is a Convex Hull.

Type ReverseEdgeLoopOrientation

Read Only No

CappingSurfaceVerticesConstraint
Provides additional information to a Capping Surface when it is constructed based on the internal loops
of a set of faces.

Properties
Algorithm

The algorithm used to construct the capping surface.

Type ConstructionAlgorithm

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
590 of ANSYS, Inc. and its subsidiaries and affiliates.
FlipLoopOrientation

Sets the orientation of the edge loop, if the algorithm is a Convex Hull.

Type ReverseEdgeLoopOrientation

Read Only No

Vertices

The set of selected Vertices.

Type LocationSet

Read Only No

CartesianTriplet
Triplet represented in cartesian coordinates

Properties
X

X coordinate

Type Expression<Quantity>

Read Only No

Y coordinate

Type Expression<Quantity>

Read Only No

Z coordinate

Type Expression<Quantity>

Read Only No

Configuration
The entity that represents a Configuration Task. Holds the list of configure controls objects.

Configure controls:

Suppress control Allows the suppression selected part compon-

ents.
Move/rotate control Allows the transformation selected part com-
ponents.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 591
Study

Properties
No Properties.

Methods
InsertVirtualPrimitiveBox

Inserts a primitive axis-alinged box that can be used to define an enclosure.

Required Arguments

CurrentSelection Location set used to define the box bounds.

Type Object

ContourResult
Displays the contour of a selected variable on a specified location.

Properties
CalculateAverage

Set to true if averages are to be calculated as part of the Result evaluation.

Type bool

Read Only No

Location

The Location over which the Result is to be evaluated.

Type LocationSet

Read Only No

RelativeTo

The Reference Frame which the result is relative to

Type ReferenceFrame

Read Only No

Variable

The solution variable to be displayed

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
592 of ANSYS, Inc. and its subsidiaries and affiliates.
CylindricalTriplet
Triplet represented in cylindrical coordinates

Properties
Phi

Angle from the +X axis in the XY plane (a.k.a. theta or phi) phi = arctan(y / x) 0 <= theta < 2PI

Type Expression<Quantity>

Read Only No

Rho

Distance from the origin in the XY plane (positive) r = sqrt(x^2 + y^2)

Type Expression<Quantity>

Read Only No

Distance from the XY plane (z coordinate)

Type Expression<Quantity>

Read Only No

DataManager
The DataManager is used to access readers and writers. This allows engineering data to be read and
written to and from files.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ProviderName

Gets or sets the name of the provider.

Type string

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 593
Study

Methods
DeleteDataManager

Deletes the specified DataManager.

Example
This example creates and then deletes a DataManager

dataManagerThermal = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\Thermal_Materials.xm
Provider="ANSYS")
Study.DeleteDataManager(dataManagerThermal)

FindByDescription

Finds items in the Data Manager, where the item's Description contains the supplied text.

Return A list of the names of the items the search found.

Type List<string>

Required Arguments

Description A string containing the text to search for.

Type string

Example
This example create a data manager and searches for a match in the description.

dataManagerThermal = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\Thermal_Materials.xm
Provider="ANSYS")
matList = Study.FindByDescription(dataManagerThermal, "Thermal Properties")

FindByModel

Finds materials in the Data Manager, where the material contains a matching model for the supplied
arguments.

Return A list of the names of the items the search found.

Type List<string>

Required Arguments

Model The string to identify the material property/model to be searched for.

Type string

Optional Arguments

Behavior The optional string to identify the behavior of the model.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
594 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Definition The optional string to identify the way in which model is defined.

Type string

Example
This example creates a data manager and searches for materials that have an Isotropic Elasticity model.

dataManagerGeneral = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\General_Materials.xm
Provider="ANSYS")
matList = Study.FindByModel(dataManagerGeneral, "Elasticity", Behavior="Isotropic")

FindByName

Finds items in the Data Manager, where the item's name contains the supplied string.

Return A list of the names of the items the search found.

Type List<string>

Required Arguments

Name The string to identify the name of the item to be searched for.

Type string

Example
This example creates a data manager and searches for any material having Alloy in the name.

dataManagerGeneral = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\General_Materials.xm
Provider="ANSYS")
matList = Study.FindByName(dataManagerGeneral, "Alloy")

FindByRange

Finds items in the Data Manager, where the item has the property and a value within the specified
range.

Return A list of the names of the items the search found.

Type List<string>

Required Arguments

MaximumQuantity The maximum quantity in the range to search for. i.e. 1 [kPa]

Type string

MinimumQuantity The minimum quantity in the range to search for. i.e. 10 [Pa]

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 595
Study

PropertyName The name of the property to use. i.e Bulk Modulus

Type string

Example
This example creates a data manager and searches for any material having density in the range of 7000
[kg m^-3] to 9000 [kg m^-3].

dataManagerGeneral = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\General_Materials.xm
Provider="ANSYS")
matList = Study.FindByRange(dataManagerGeneral, "Density", "7000 [kg m^-3]" ,"9000 [kg m^-3]")

GetValidContentNames

Gets the names of all the items in the Data Manager.

Return A List of strings containing the names of the items loaded into the
DataManager.

Type List<string>

Optional Arguments

DataType The type of data to be returned.

Type string

Default Value Material

Example
This example creates a data manager and returns the items it is managing.

dataManagerGeneral = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\General_Materials.xm
Provider="ANSYS")
contents = Study.GetValidContentNames(dataManagerGeneral)

Density
The Density model provided via a specified expression.

Properties
Magnitude

The Magnitude is an expresion which evaluates to a Quantity with the correct units.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
596 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryDimension
Dimension parameter imported from CAD.

Properties
Value

Dimension parameter value.

Type Quantity

Read Only No

GeometryImportSource
Defines an imported geometry source through direct file browsing or an active CAD attach source.
Provides the ability to update the geometry from the source system.

Properties
ActiveCADAttachSource

The Active CAD Source chosen from the option list

Type string

Read Only No

FilePath

Import source location.

Type string

Read Only No

MaterialAssignments

Material assignments brought in by this import.

Type List<MaterialAssignment>

Read Only No

PlugInName

Displays the current plugin name when the source has been defined by an active CAD attach.

Type string

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 597
Study

SourceSelectionMode

Controls how the source selection if defined.

Selection Types:

BrowseSource Source is specified using the file browser dia-

log.
ActiveCADAttach Source is specified by an active CAD attach
source.

Type SourceSelectionType

Read Only No

SourceType

Import source type.

Type string

Read Only Yes

Methods
BrowseImportSourceOperation

Sets an import source file location through a file browser dialog.

Required Arguments

FilePath Path to the chosen file.

Type string

GenerateImportSourceOperation

Generates the output for a specific Geometry Import Source.

UpdateGeometryImportSource

Updates a specific Geometry Import Source from the source CAD system. Any changed parameter values
associated with this import source are pushed to the source CAD system.

UpdateGeometryImportSourceFromCAD

Updates a specific Geometry Import Source from the source CAD system. Parameter values associated
with the import source are synchronized with the current values defined in the source CAD system.

GeometryPreferences
Defines geometry import preferences used during the initial geometry import and any subsequent up-
dates.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
598 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
DecomposeDisjointFaces

Enables the decomposition of disjoint faces into separate face entities. The default is No.

Type bool

Read Only No

DimensionKey

Allows the specification of a key that is used to filter processed CAD System Parameters during import.
The key must be present at the beginning or the end of a CAD Parameter's name to be valid for import.
The Dimension Key supports multiple prefixes/suffixes with each value separated by a semicolon. If the
value is empty, all Dimensions are imported. The default key is "DS".

Type string

Read Only No

ExplodeUnsharedComponents

Allows components containing multiple bodies to be exploded into independent parts if no shared
topology options have been defined.

Type bool

Read Only No

ImportCoordinateSystems

Specifies whether coordinate systems created in the CAD System are imported as Reference Frame
objects. The default is No.

Type bool

Read Only No

ImportDimensions

Enables Dimension processing. Dimension processing can have a negative impact on overall import
performance. The default is Yes.

Type bool

Read Only No

ImportNamedSelections

Enables processing of CAD System Named Selections that result in the creation of Selection Sets. The
default is No.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 599
Study

ImportSheets

Enables the import of surface bodies. The default is Yes.

Type bool

Read Only No

ImportSolids

Enables the import of solid bodies. The default is Yes.

Type bool

Read Only No

MixedResolution

Allows parts of mixed dimension to be imported as components of assemblies which have parts of
different dimensions. The default is None.

The following options control what is imported when there are bodies of mixed dimension in a multi-
body part:

None Nothing is imported.

Solid Only solids are imported.
Sheet Only sheet surfaces are imported.
SolidSheet Only solids and sheet surfaces are imported.

Type MixedResolutionType

Read Only No

NamedSelectionKey

Allows the specification of a key that is used to filter processed CAD System Named Selections during
import. The key must be present at the beginning or end of a CAD Named Selection's name to be valid
for import. The Selection Set Key supports multiple prefixes/suffixes with each value separated by a
semicolon. If the value is empty, all Selection Sets are imported. The default key is "NS".

Type string

Read Only No

ProcessAssociativity

Indicates if action should be taken to allow associativity. Associativity processing can have a negative
impact on import performance. The default is Yes.

Type bool

Read Only No

ProcessEnclosures

Enables the processing of enclosure and symmetry CAD System Named Selections. The default is Yes.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
600 of ANSYS, Inc. and its subsidiaries and affiliates.
Type bool

Read Only No

ReaderSaveUpdate

Enables saving of the internal part files generated from the geometry import during the import/update
action. The default is No.

Type bool

Read Only No

UseInstances

Honors a geometry import's part instances during processing to produce faster import times and allow
smaller database sizes. The default is Yes.

Type bool

Read Only No

GlobalMeshAdvancedAttributes
GlobalMeshAdvancedAttributes specifies the global advanced properties for Part Meshing.

Available options:

ShapeChecking Determines the shape checking algorithm to

be used by the mesher.
TriangleSurfaceMesher Determines surface meshing algorithm to be
used by patch conforming mesher.
ElementMidsideNodes Determines whether elements are with or
without midside nodes.
StraightSidedElements Specifies meshing to straight edge elements.
LoopRemovalTolerance Specifies the tolerance value for sheet loop
removal.
MeshBasedDefeaturing Specifies automatic defeaturing of dirty geo-
metries.
DefeaturingTolerance Specifies the defeaturing tolerance value.
UseAllProcessors Specifies if all available processors are used
for parallel part-based meshing.
ProcessorLimit Specifies the maximum number of processors
to be utilized for parallel part-based meshing.

Properties
DefeaturingTolerance

Specifies the defeaturing tolerance value.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 601
Study

ElementMidsideNodes

Determines whether elements are with or without midside nodes.

Available options:

UseEngineeringIntent Determine whether midside nodes are kept

or dropped based on the Engineering Intent.
Dropped Elements without midside nodes.
Kept Elements with midside nodes.

Type ElementMidsideNodes

Read Only No

LoopRemovalTolerance

Specifies the tolerance value for sheet loop removal. Any loop with radius less than or equal to Loop
Removal Tolerance value is removed by mesher. Setting the tolerance value to 0 means that no loops
will be removed.

Type Quantity

Read Only No

MeshBasedDefeaturing

Specifies automatic defeaturing of dirty geometries.

Available options:

AutomaticallyDetermined Automatically removes features smaller than

or equal to the calculated default tolerance
value on dirty geometry.
UserDefined Automatically removes features smaller than
or equal to the user defined defeaturing toler-
ance value on dirty geometry.
Off No defeaturing done on dirty geometry.

Type MeshBasedDefeaturing

Read Only No

ProcessorLimit

Specifies the number of processors to be used by part-based meshing task to enhance performance
and ranges from 0 to 64. Default value of 0 (when Use all processors = Yes) automatically ensures that
maximum number of available CPU cores are utilized.

Type uint

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
602 of ANSYS, Inc. and its subsidiaries and affiliates.
ShapeChecking

Determines the shape checking algorithm to be used by the mesher.

Available options:

UseEngineeringIntent Determine which algorithm to use based on

the Engineering Intent.
StandardMechanical Specifies the standard mechanical shape
checking algorithm for structural simulations.
AggressiveMechanical Specifies the aggressive mechanical shape
checking algorithm for structural simulations.
CFD Specifies the CFD shape checking algorithm
for flow simulations.
None Disable shape checking.

Type ShapeChecking

Read Only No

StraightSidedElements

Specifies meshing to straight edge elements.

Available options:

No
Yes

Type StraightSidedElements

Read Only No

TriangleSurfaceMesher

Determines surface meshing algorithm to be used by patch conforming mesher.

Available options:

Program Controlled Mesher determines usage of Delaunay or Ad-

vancing Front algorithm.
Advancing Front Mesher uses Advancing Front algorithm but
can switch to Delaunay if problems occur.

Type TriangleSurfaceMesher

Read Only No

UseAllProcessors

Specifies usage of all available processors for parallel part-based meshing.

Available options:

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 603
Study

No Manually specify the limit to the number of

processors that can be utilized for parallel
part-based meshing.
Yes Automatically detects and utilizes all available
processors for meshing parts of an assembly
in parallel.

Type UseAllProcessors

Read Only No

GlobalMeshInflationAttributes
GlobalMeshInflationAttributes specifies the global inflation properties.

Available options:

CollisionAvoidance Determines strategy to avoid collision

between inflated surface meshes.
FixFirstLayer Determines whether the heights or ratios of
the first inflation layer will be modified to
avoid collision.
GapFactor Specifies gap between intersecting prisms.
MaxHeightOverBase Specifies maximum allowable prism aspect
ratio.
GrowthRateType Determines height of inflation layer for given
initial height and height ratio.
MaxAngle Specifies the maximum prism layer growth
angle.
FilletRatio Specifies whether fillets proportional to the
prism height will be created in corner zones
of tetrahedral mesh.
UsePostSmoothing Specifies whether post inflation smoothing
will be performed.
SmoothIterations Specifies the number of post inflation
smoothing iterations.

Properties
CollisionAvoidance

Determines strategy to avoid collision between inflated surface meshes.

Available options:

None No check for layer collisions.

LayerCompression Inflation layers are compressed in collision
areas.
StairStepping Prism layers are stair stepped to avoid collision
and maintain the gap defined by gap factor.

Type CollisionAvoidance

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
604 of ANSYS, Inc. and its subsidiaries and affiliates.
FilletRatio

Specifies whether fillets proportional to the prism height will be created in corner zones of tetrahedral
mesh.

Type double

Read Only No

FixFirstLayer

Determines whether the heights or ratios of the first inflation layer will be modified to avoid collision.

Available options:

No
Yes

Type FixFirstLayer

Read Only No

GapFactor

Specifies gap between intersecting prisms.

Type double

Read Only No

GrowthRateType

Determines height of inflation layers for given initial height and height ratio.

Available options:

Geometric Height of inflation layer determined geomet-

rically.
Linear Height of inflation layer determined linearly.
Exponential Height of inflation layer determined exponen-
tially.

Type GrowthRateType

Read Only No

MaxAngle

Specifies the maximum prism layer growth angle.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 605
Study

MaxHeightOverBase

Specifies maximum allowable prism aspect ratio.

Type double

Read Only No

SmoothIterations

Specifies the number of post inflation smoothing iterations.

Type int

Read Only No

UsePostSmoothing

Specifies whether post inflation smoothing will be performed.

Available options:

No
Yes

Type UsePostSmoothing

Read Only No

GlobalMeshSizingAttributes
GlobalMeshSizingAttributes specifies the global mesh sizing attributes.

Available options:

InheritanceWrap Specifies whether the sizing function for sew

is inherited from the predecessor wrap task
or not.
UseAdvancedSizeFunction Specifies options for advanced size function.
MinSize Specifies the minimum size returned to the
mesher.
ProximityMinSize Specifies global minimum size when Advanced
Size Function is Proximity and Curvature or
Proximity.
MaxFaceSize Specifies maximum size returned to the sur-
face mesher.
MaxSize Specifies the maximum size returned to the
mesher.
ProximitySizeFunctionSources Specifies the source type to be used for size
function calculation when Advanced Size
Function is Proximity or Curvature and prox-
imity.
GrowthRate Specifies the increase in edge length with
each succeeding layer of elements.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
606 of ANSYS, Inc. and its subsidiaries and affiliates.
 CurvatureNormalAngle Specifies maximum allowable angle that one
element is allowed to span when Advanced
Size Function is Proximity and Curvature or
Curvature.
NumberOfCellsAcrossGap Specifies minimum number of elements to be
generated in gaps when Advanced Size
Function is Proximity and Curvature or Prox-
imity.
Smoothing Specifies the number of smoothing iterations.
AdaptiveResolution The scaling value for the arguments of various
functions for the adaptive size function.

Properties
AdaptiveResolution

Specifies adaptive resolution

Type double

Read Only No

CurvatureNormalAngle

Specifies maximum allowable angle that one element is allowed to span when Advanced Size Function
is Proximity and Curvature or Curvature.

Type Quantity

Read Only No

ElementSeedSize

Specifies the element seed size returned to the mesher.

Type Quantity

Read Only No

GrowthRate

Specifies the increase in edge length with each succeeding layer of elements.

Type double

Read Only No

MaxFaceSize

Specifies maximum size returned to the surface mesher.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 607
Study

MaxSize

Specifies the maximum size returned to the mesher.

Type Quantity

Read Only No

MinSize

Specifies the minimum size returned to the mesher.

Type Quantity

Read Only No

NumberOfCellsAcrossGap

Specifies minimum number of elements to be generated in gaps when Advanced Size Function is
Proximity and Curvature or Proximity.

Type int

Read Only No

ProximityMinSize

Specifies global minimum size when Advanced Size Function is Proximity and Curvature or Proximity.

Type Quantity

Read Only No

ProximitySizeFunctionSources

Specifies the source type to be used for size function calculation when Advanced Size Function is
Proximity or Curvature and proximity.

Available options:

Faces
Edges
FacesAndEdges

Type ProximitySizeFunctionSources

Read Only No

Smoothing

Specifies the number of smoothing iterations.

Available options:

Low
Medium

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
608 of ANSYS, Inc. and its subsidiaries and affiliates.
 High

Type Smoothing

Read Only No

UseAdvancedSizeFunction

Specifies options for advanced size function.

Available options:

Adaptive
Curvature
Proximity
Fixed
ProximityCurvature

Type UseAdvancedSizeFunction

Read Only No

UseFixedSizeFunctionForSheets

Specifies use of Fixed Size function for sheets if there are present in the geometry.

Type bool

Read Only No

GlobalParametersExtension
Frequency parameters for Results

Properties
Frequency

The computed Frequency for this Result.

Type Quantity

Read Only Yes

FrequencyImaginary

The Imaginary (damping) component in the computed Frequency.

Type Quantity

Read Only Yes

FrequencyReal

The Real (stability) component in the computed Frequency.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 609
Study

Type Quantity

Read Only Yes

GlobalWrapSewAdvancedAttributes
GlobalWrapSewAdvancedAttributes specifies the global advanced properties for wrap and sew.

Available options:

TessellationRefinement Specifies value to be used for tessellation re-

finement.
RefinementTolerance Specifies the user-defined tolerance for tessel-
lation refinement.
EdgeExtractionAngle Determines which CAD features are captured.
CreateIntersectingEdgesForOverlappingBodies Create intersecting edges for overlapping
bodies.
Zoning Specifies options for zoning.
TargetMetric Specifies the measure for mesh quality.
MetricValue Specifies the value at which wrapper surface
will be improved.
Aggressive Specifies whether mesh may deviate from
geometry as a result of wrapper surface im-
provement.

Properties
Aggressive

Specifies whether mesh may deviate from geometry as a result of wrapper surface improvement.

Available options:

MeetTarget
MaintainGeometry

Type Aggressive

Read Only No

CreateIntersectingEdgesForOverlappingBodies

Create intersecting edges for overlapping bodies.

Available options:

No
Yes

Type CreateIntersectingEdgesForOverlappingBodies

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
610 of ANSYS, Inc. and its subsidiaries and affiliates.
EdgeExtractionAngle

Determines which CAD features are captured.

Type Quantity

Read Only No

MetricValue

Specifies the value at which wrapper surface will be improved.

Type double

Read Only No

RefinementTolerance

Specifies the refinement tolerance for user defined tessellation refinement.

Type Quantity

Read Only No

TargetMetric

Specifies the measure for mesh quality.

Available options:

Skewness
SizeChange
AspectRatio

Type Metric

Read Only No

TessellationRefinement

Specifies value to be used for tessellation refinement.

Available options:

AutomaticallyDetermined Sets tessellation refinement to 10% of the

value of Min Size/Proximity Min Size.
UserDefined Sets tessellation refinement to user defined
value.
Off Tessellation refinement is not performed.

Type TessellationRefinement

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 611
Study

Zoning

Specifies options for zoning.

Available options:

Part
Body
Face

Type Zoning

Read Only No

Import
Main Data Import Task user object. Holds the list of import source objects

Properties
No Properties.

Methods
AddActiveCADAttachSourceOperation

Creates a single Geometry Import Source within an Import Task. The import source object will be initial-
ized with its source selection mode set to Active CAD Attach.

AddGeometryImportSourceOperation

Adds a single Geometry Import Source to an Import Task.

Return Reference to the Geometry Import Source.

Type DataReference

Optional Arguments

FilePath Path to the chosen file.

Type string

ChooseImportSources

Multiple selection of import source files. The file list is processed and import source objects are created
within the Import Task.

Required Arguments

FilePaths List of paths to the chosen files.

Type List<string>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
612 of ANSYS, Inc. and its subsidiaries and affiliates.
IsoSurface
Creates surfaces of constant value of the specified variable.

Properties
IsovalueMethod

The method by which isovalues are defined.

Type IsovalueMethod

Read Only No

Isovalues

The list of isovalues.

Type List<Quantity>

Read Only No

Location

The Location over which the Result is to be evaluated.

Type LocationSet

Read Only No

NumberOfIsovalues

The number of isovalues.

Type int

Read Only No

Variable

The variable of interest.

Type Expression<Quantity>

Read Only No

IsotropicElasticity
The Isotropic Elasticity material model.

Properties
Derivation

The Isotropic Elasticity values can be entered for one of the following combinations:

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 613
Study

YoungsModulusPoissonsRatio Young's Modulus and Poisson's Ratio

ShearModulusPoissonsRatio Shear Modulus and Poisson's Ratio
BulkModulusPoissonsRatio Bulk Modulus and Poisson's Ratio
YoungsModulusShearModulus Young's Modulus and Shear Modulus
YoungsModulusBulkModulus Young's Modulus and Bulk Modulus
BulkModulusShearModulus Bulk Modulus and Shear Modulus

which will then compute the other values using Hooke's law.

Type DerivationType

Read Only No

Magnitude

The Magnitude is used for an expresion to include variations of the data for any independent variable
(e.g. Temperature).

Type Expression<IsotropicElasticityDependents>

Read Only No

IsotropicResistivity
The input for resistivity which is isotropic.

This can be used in an electric/magnetic analysis.

Properties
Magnitude

Gets or sets the magnitude.

Type Expression<Quantity>

Read Only No

IsotropicSecantCoefficientofThermalExpansion
The Isotropic Secant Coefficient of Thermal Expansion material model.

Properties
Magnitude

The Magnitude is an expresion which evaluates to a Quantity with the correct units.

Type Expression<Quantity>

Read Only No

IsotropicSeebeckCoefficient
Seebeck Coefficient : Isotropic model.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
614 of ANSYS, Inc. and its subsidiaries and affiliates.
Can be applied to Thermal analyses

Properties
Magnitude

Gets or sets the magnitude.

Type Expression<Quantity>

Read Only No

IsotropicThermalConductivity
The Isotropic Thermal Conductivity material model.

Properties
Magnitude

The Magnitude is an expresion which evaluates to a Quantity with the correct units.

Type Expression<Quantity>

Read Only No

Legend
Specifies how the legend for the current object should be displayed.

Properties
Coloring

Specifies smooth or banded coloring.

Type LegendColoring

Read Only No

NumberOfColors

The number of colors to be used.

Type int

Read Only No

Material
The material object holds all information that defines the behavior for a specific material.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 615
Study

Properties
Description

A description of the material contents.

Type string

Read Only No

SourceInformation

Information about the original source of this managed engineering data.

Type SourceInformation

Read Only Yes

Methods
AddPropertyTable

This command is used to allow the expression of a property to reference data in the named table. This
is a reference and not a copy, and so if the table is used in the expression, and a change is made on
the referenced table and the change is in the data being referenced the value of the property will be
modified. The command creates table functions in the context of this expression which can be used
with constants, field variables, or another named expression. If the property does not support an expres-
sion an error will occur.

Return An int which corresponds to the Index passed in to the command and
indicates the comand successfully completed.

Type int

Required Arguments

Dependents A List of the column index(es) to use from the Table which correspond to the dependent
variable(s) of the Property. The indexes can be an Integer index or the String name of the
column.

Type List<Object>

Independents A List of the column index(es) to use from the Table for use in the expression and correspond
to the independent variables of the Property. The indexes can be an Integer index or the
String name of the column.

Type List<Object>

Index An integer which uniquely identifies the Table for use in the expression of the Property. In
the expression this table can be accessed via tableIndex(args). The table with an index of
one can be accessed in the expression as table(args) or table1(args).

Type uint

Property The String which provides the path of the property on the Parent.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
616 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Table The DataReference of the table to add to the Property.

Type DataReference

Optional Arguments

Bounds An enum which describes what will occur when the index is outside of the bounds of the
table. The valid enum values are; Constant, Fit, Zero, and Error. The default is Error.

Type TableInterpolationBeyondBounds

Default Value Error

Interpolation An enum of the type of interpolation to use when accessing data from the table at a
given index. The valid enum values are; None, Linear, Cubic Spline. The default is Linear.

Type TableInterpolation

Default Value Linear

Example

tbl1 = pressure1.CreateTable(Columns=[[“X”, “Length”], [“Y”, “Length”], [“Z”, “Length”], [“Pressure”, “Pres

#
# Use three of the columns from tbl1
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Index=1, Independents=[“X”, “Y”], Dependents=[“Press
# In the table function the x and y refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expresssion=“table1(x, y)”)
#
# Use four of the columns from tbl1
bc1.AddPropertyTable(Property=“Temperature”, Table=tbl1, Index=1, Independents=[“X”, “Y”, “Z”], Dependents=
# In the table function the x, y, and z refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Temperature”, Expression=“table1(x, y, z)”)
#
# Use two of the columns from tbl1
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Index=1, Independents=[“X”], Dependents=[“Pressure”]
# In the table function the x refers to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(x)”)
#
# Use of a constant
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(20)”)

CreateContent

Includes a physical quantity or the constitutive relation for the physical response of a material.

The material property is created based on the specified optional parameters "Definition" and "Behavior".

You can use the GetValidMaterialContentQuery query to obtain a list of available property/models with
the corresponding behavior and/or definition.

Optional Arguments

Behavior The optional string to identify the behavior of the property/model.

The behavior typically refers to how the material responds, e.g., the density property
could behave as an Ideal Gas or a Real Gas.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 617
Study

Type string

Definition The optional string to identify the way in which new material property/model will be defined.

In some cases the material property/model may be defined in different ways, e.g.,
Thermal Expansion can be defined using Secant or Instantaneous.

Type string

Model The string to identify the material property/model to be included.

Type string

Example
This example assumes that a material has been created.

It then adds the Isotropic Elasticity model to the material

material1.CreateContent(Model="Elasticity", Definition="", Behavior="Isotropic")

CreatePropertyTable

CreatePropertyTable is a convenience command which performs the following commands:

Creates a table. See the CreateEntity command, where Type="Table".

Adds columns corresponding to the Fields parameter and the dependent variables of the
Property parameter. See the and AddTableColumn command.
Adds the table to the Property parameter. See the AddPropertyTable command.
Sets the expression on the Property parameter to “table(Fields)”. See the SetPropertyExpression
command.

Return The DataReference of the newly created table.

Type DataReference

Required Arguments

Fields A List of field variable names to be used as the independent variables for this property. The de-
pendent variables are defined by the Property.

Type List<string>

Property The String which provides the path of the property on the Parent.

Type string

Example
This example creates a new Table for the Isotropic Resistivity property in a material.

# drMaterial is the DataReference of the material having an Isotropic Resistivity property

table1 = material1.CreatePropertyTable(
Property="IsotropicResistivity.Magnitude",
Fields=["Temperature"])
table1.AddRow(Data=["100 [C]",".01 [ohm m]"])
table1.AddRow(Data=["200 [C]",".02 [ohm m]"])
table1.AddRow(Data=["300 [C]",".06 [ohm m]"])

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
618 of ANSYS, Inc. and its subsidiaries and affiliates.
 table1.GetData()

DeleteContent

Deletes a material model from the specified material.

Required Arguments

Model The string to identify the material property/model to be removed.

Type string

Optional Arguments

Behavior The optional string to identify the behavior of the property/model that is to be deleted.

The behavior typically refers to how the material responds, e.g., the density property
could behave as an Ideal Gas or a Real Gas.

Type string

Definition The optional string to identify the way in which material property/model to be deleted was
defined.

In some cases the material property/model may be defined in different ways, e.g.,
Thermal Expansion can be defined using Secant or Instantaneous.

Type string

Example
This example deletes the Isotropic Elasticity model from an already created material.

material1.DeleteContent(Model="Elasticity", Definition="", Behavior="Isotropic")

ExportEngineeringData

ExportEngineeringData allows an engineering data object which can be managed to be exported to a

source via a DataManager

Required Arguments

Source The source that this data will be exported to, via the Data Manager.

Type string

Optional Arguments

DataManager The data manager which is managing the requested engineering data. If not provided then
the DataManager associated with the Entity will be used. If the Entity has no associated
DataManager the default ANSYS Data Manager will be used.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 619
Study

Format The format which the Data Manager should use to save the entity. If it is not provided the
DataManager will determine it based on the Source. If the Source does not yet exist the Data
Manager will determine the format if it is a single type or throw an exception if the Format
is not provided.

Type string

Default Value HDF5

Example
This example assumes that a material and data manager exist in the Study

dataManager1 = GetDataEntity("/MaterialDataContainer/DataManager:DataManager 1")

material1.ExportEngineeringData(
Source=r"C:\Users\epc\AppData\Roaming\Ansys\v151\Engineering_Data_Library.xml",
DataManager=dataManager1)

ImportEngineeringData

ImportEngineeringData allows an engineering data object which can be managed to import data from
a source via a DataManager

Required Arguments

Name The name of the engineering data to import from the DataManager.

Type string

Optional Arguments

DataManager The data manager which is managing the requested engineering data. If not provided then
the DataManager associated with the Entity will be used. If the Entity has no associated
DataManager the default ANSYS Data Manager will be used.

Type DataReference

Source The source of the data which will be managed by the Data Manager. If it is not provided the
Source property of the DataManager will be used, if it is not set then an exception will occur.

Type string

Example
The example assumes that a material has already been created.

material1.ImportEngineeringData(Name="Aluminum Alloy")

RemovePropertyTable

Remove a table reference from a property to prevent its use in an expression. If the property does not
support an expression an error will occur.

Required Arguments

Index The integer which uniquely identifies the Table for use in the expression of the Property.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
620 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type uint

Property The String which provides the path of the property on the Parent.

Type string

Example

tbl1 = pressure1.CreateTable(Columns=[[“X”, “Length”], [“Y”, “Length”], [“Pressure”, “Pressure”]])

bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Independents=[“X”, “Y”], Dependents=[“Pressure”])
# In the table function the x and y refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(x, y)”)
bc1.RemovePropertyTable(Property=“Magnitude”, Index=1);

MaterialAssignment
Assigns a Material to a specified Location.

Properties
Location

The Location for the Material.

Type LocationSet

Read Only No

Material

The reference to the Material.

Type Material

Read Only No

MeshControlBodySizing
Body Sizing control which contains all sizing options a user can place on a Body reference

Properties
Behavior

Specifies whether size control settings can be changed by the mesher (Soft) or not (Hard).

Available options:

Soft
Hard

Type SizingBehavior

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 621
Study

CurvatureNormalAngle

Specifies maximum angle that one element edge is allowed to span.

Type Quantity

Read Only No

ElementSize

Specifies the maximum size for the edge, face or body sizing control.

Type Quantity

Read Only No

GrowthRate

Specifies increase in element edge length with each succeeding layer of elements.

Type double

Read Only No

LocalMinSize

Specifies value to override global Min Size on local entities.

Type Quantity

Read Only No

Location

A common property for all sub meshing objects with a defined Geometry Filter

Type LocationSet

Read Only No

UseAutomaticallyDefinedLocation

A common toggle for all sub meshing objects with a Location property so that it can be automatically
set. Currently only visible in Inflation object.

Type bool

Read Only No

MeshControlEdgeSizing
Specifies attributes for edge sizing.

Available options:

EdgeSizingMethod Specifies the edge sizing method.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
622 of ANSYS, Inc. and its subsidiaries and affiliates.
 EdgeDivisions Specifies the number of divisions on each
edge.
BiasMethod Specifies bias option which is always smooth
transition.
BiasType Specifies option for bias type.
BiasGrowthRate Specifies value for bias growth rate.

Properties
Behavior

Specifies whether size control settings can be changed by the mesher (Soft) or not (Hard).

Available options:

Soft
Hard

Type SizingBehavior

Read Only No

BiasGrowthRate

Specifies value for bias growth rate.

Type double

Read Only No

BiasMethod

Specifies bias option which is always smooth transition.

Type BiasMethod

Read Only No

BiasType

Specifies option for bias type.

Available options:

Right
Left
CenterIn
CenterOut
Constant

Type BiasType

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 623
Study

CurvatureNormalAngle

Specifies maximum angle that one element edge is allowed to span.

Type Quantity

Read Only No

EdgeDivisions

Specifies the number of divisions on each edge.

Type int

Read Only No

EdgeSizingMethod

Specifies the edge sizing method.

Available options:

ElementSize
EdgeDivisions

Type EdgeSizingMethod

Read Only No

ElementSize

Specifies the maximum size for the edge, face or body sizing control.

Type Quantity

Read Only No

GrowthRate

Specifies increase in element edge length with each succeeding layer of elements.

Type double

Read Only No

LocalMinSize

Specifies value to override global Min Size on local entities.

Type Quantity

Read Only No

Location

A common property for all sub meshing objects with a defined Geometry Filter

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
624 of ANSYS, Inc. and its subsidiaries and affiliates.
Type LocationSet

Read Only No

UseAutomaticallyDefinedLocation

A common toggle for all sub meshing objects with a Location property so that it can be automatically
set. Currently only visible in Inflation object.

Type bool

Read Only No

MeshControlElementShape
Mesh Method properties

Properties
LocalElementMidsideNodes

Show options to select the Local Element Midside Nodes

Type LocalElementMidsideNodes

Read Only No

Location

A common property for all sub meshing objects with a defined Geometry Filter

Type LocationSet

Read Only No

Shape

Show options to select the Mesh Method

Type ElementShape

Read Only No

SourceLocation

Source Location for MultiZone/thin Sweep/Sweep Methods

Type LocationSet

Read Only No

TargetLocation

Target Location for sweep Method

Type LocationSet

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 625
Study

Read Only No

UseAutomaticallyDefinedLocation

A common toggle for all sub meshing objects with a Location property so that it can be automatically
set. Currently only visible in Inflation object.

Type bool

Read Only No

MeshControlFaceSizing
Face Sizing control to be scoped to a topological selection of faces.

Properties
Behavior

Specifies whether size control settings can be changed by the mesher (Soft) or not (Hard).

Available options:

Soft
Hard

Type SizingBehavior

Read Only No

CurvatureNormalAngle

Specifies maximum angle that one element edge is allowed to span.

Type Quantity

Read Only No

ElementSize

Specifies the maximum size for the edge, face or body sizing control.

Type Quantity

Read Only No

GrowthRate

Specifies increase in element edge length with each succeeding layer of elements.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
626 of ANSYS, Inc. and its subsidiaries and affiliates.
LocalMinSize

Specifies value to override global Min Size on local entities.

Type Quantity

Read Only No

Location

A common property for all sub meshing objects with a defined Geometry Filter

Type LocationSet

Read Only No

UseAutomaticallyDefinedLocation

A common toggle for all sub meshing objects with a Location property so that it can be automatically
set. Currently only visible in Inflation object.

Type bool

Read Only No

MeshControlLocalInflation
Specifies local inflation attributes.

Available options:

InflationOption Specifies the way heights of the inflation lay-

ers are determined.
FirstLayerHeight Specifies the height of the first inflation layer.
FirstAspectRatio Specifies the aspect ratio of the inflations that
are extruded from the inflation base.
TransitionRatio Specifies the rate at which adjacent elements
grow.
NumberOfLayers Specifies the number of inflated layers.
MaximumLayers Specifies the maximum number of inflation
layers to be created.
GrowthRate Specifies the value for Growth Rate.
AspectRatio Specifies relative thickness of adjacent infla-
tion layers.
MaximumThickness Specifies the desired maximum thickness of
the inflation layer.
InflationAlgorithm Specifies pre or post inflation algorithm to be
used by the mesher.

Properties
AspectRatio

Specifies relative thickness of adjacent inflation layers.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 627
Study

Type double

Read Only No

FirstAspectRatio

Specifies the aspect ratio of the inflations that are extruded from the inflation base.

Type double

Read Only No

FirstLayerHeight

Specifies the height of the first inflation layer.

Type Quantity

Read Only No

GrowthRate

Specifies the value for Growth Rate.

Type double

Read Only No

InflationAlgorithm

Specifies pre or post inflation algorithm to be used by the mesher.

Available options:

Post
Pre

Type InflationAlgorithm

Read Only No

InflationOption

Specifies the way heights of the inflation layers are determined.

Available options:

SmoothTransition Mesher ensures smooth rate of volume change

using local tetrahedral element size.
TotalThickness Creates constant inflation layers using the
values of Number of Layers and Growth Rate.
FirstLayerThickness Creates constant inflation layers using values
of First Layer Height, Maximum Layers and
Growth Rate.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
628 of ANSYS, Inc. and its subsidiaries and affiliates.
 FirstAspectRatio Creates inflation layers using values of First
Aspect Ratio, Maximum Layers and Growth
Rate.
LastAspectRatio Creates constant inflation layers using values
of First Layer Height, Maximum Layers and
Aspect Ratio.

Type InflationOption

Read Only No

Location

A common property for all sub meshing objects with a defined Geometry Filter

Type LocationSet

Read Only No

MaximumLayers

Specifies the maximum number of inflation layers to be created.

Type int

Read Only No

MaximumThickness

Specifies the desired maximum thickness of the inflation layer.

Type Quantity

Read Only No

NumberOfLayers

Specifies the number of inflated layers.

Type int

Read Only No

TransitionRatio

Specifies the rate at which adjacent elements grow.

Type double

Read Only No

UseAutomaticallyDefinedLocation

A common toggle for all sub meshing objects with a Location property so that it can be automatically
set. Currently only visible in Inflation object.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 629
Study

Type bool

Read Only No

MeshDiagnostics
MeshDiagnostics specifies the settings used to evaluate mesh quality.

Available options:

GeometryLocation Specifies the selected topology set or the en-

tire model for which mesh diagnostics are
evaluated during part-based Meshing.
MeshMetric Specifies the metric type based on which
mesh quality is evaluated.
NumNodes Specifies number of nodes in the mesh.
NumElements Specifies number of elements in the mesh.
MinMetric Specifies the minimum value for chosen metric
type.
MaxMetric Specifies the maximum value for chosen
metric type.
AverageMetric Specifies the average value for chosen metric
type.
StandardDeviation Specifies the standard deviation value for
chosen metric type.

Properties
AverageMetric

Specifies the average value for chosen metric type.

Type double

Read Only No

Location

A common property for all sub meshing objects with a defined Geometry Filter

Type LocationSet

Read Only No

MaxMetric

Specifies the maximum value for chosen metric type.

Type double

Read Only No

MeshMetric

Specifies the metric type based on which mesh quality is evaluated.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
630 of ANSYS, Inc. and its subsidiaries and affiliates.
Available options:

ElementQuality A composite quality metric is computed ran-

ging between 0 and 1.
AspectRatio Aspect ratio is calculated based only on corner
nodes of elements.
JacobianRatio Jacobian ratio is computed for all elements
except those with no midside nodes or per-
fectly centered midside nodes.
WarpingFactor Warping factor is computed for quadrilateral
shell elements and quadrilateral faces of
bricks, wedges and pyramids.
ParallelDeviation Parallel deviation is computed ignoring mid-
side nodes and based on unit vectors along
each element size.
MaximumCornerAngle Maximum corner angles are computed
between adjacent edges and high corner
angles can degrade element performance.
Skewness Skewness is one primary quality measure that
determines how close to ideal (that is, equilat-
eral or equiangular) a face or cell is.
OrthogonalQuality Orthogonal quality is computed using face
normal vectors and ranges from 0 to 1.
None No mesh metric type is selected.

Type MeshMetric

Read Only No

MinMetric

Specifies the minimum value for chosen metric type.

Type double

Read Only No

NumElements

Specifies number of elements in the mesh.

Type int

Read Only No

NumNodes

Specifies number of nodes in the mesh.

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 631
Study

StandardDeviation

Specifies the standard deviation value for chosen metric type.

Type double

Read Only No

UseAutomaticallyDefinedLocation

A common toggle for all sub meshing objects with a Location property so that it can be automatically
set. Currently only visible in Inflation object.

Type bool

Read Only No

Methods
EvaluateMeshDiagnostics

Evaluates the output mesh metrics for a given Mesh Diagnostics control.

MeshDisplayProperties
Base class for display state objects with reference Ids or reference names.

Properties
No Properties.

MeshDisplayPropertiesWithIds
Object returned by mesh display state queries with reference Ids and their corresponding display state
properties.

Available properties:

State Meshing state for entity. [ 0 = Unmeshed, 1 =

Meshed, 2 = OutOfDate, 3 = Failed, 4 = Sup-
pressed, 5 = Connected, 6 = NeedsConnected
]
MeshColor Color with which the mesh element edges
should be drawn by graphics.
Translucency Translucency value with which the mesh ele-
ment faces should be drawn by graphics.
ShowMesh Flag to tell graphics whether to overlay the
mesh on the entity or not.
ReferenceIds A list of entity reference Ids that are associated
with a given meshing state.

Properties
No Properties.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
632 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshDisplayPropertiesWithStrings
Object returned by mesh display state queries with reference names and their corresponding display
state properties.

Available properties:

State Meshing state for entity. [ 0 = Unmeshed, 1 =

Meshed, 2 = OutOfDate, 3 = Failed, 4 = Sup-
pressed, 5 = Connected, 6 = NeedsConnected
]
MeshColor Color with which the mesh element edges
should be drawn by graphics.
Translucency Translucency value with which the mesh ele-
ment faces should be drawn by graphics.
ShowMesh Flag to tell graphics whether to overlay the
mesh on the entity or not.
ReferenceNames A list of entity reference names that are asso-
ciated with a given meshing state.

Properties
No Properties.

Meshing
Meshing Task is used to determine (in a smart way) which meshing technology to use for meshing the
model. A mesh can be generated by either (1) selectively meshing parts or entire assemblies of parts,
or (2) filling in the volume of a surface mesh created by a Wrap task.

Available options:

EngineeringIntent Defines the kind of physics that is being

studied in this simulation process (used in
part-based Meshing).

Properties
EngineeringIntent

Defines the kind of physics that is being studied in this simulation process (used in part-based Meshing).

Available options:

StructuralOrThermal Intent of this process is a structural and/or

thermal simulation.
FluidFlow Intent of this process is a fluid flow simulation.

Type EngineeringIntent

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 633
Study

MeshingRetries

Will tell the mesher to try again with finer sizing inputs if the first attempt at meshing fails.

Type bool

Read Only No

MeshResolution

Defines the resolution for automatically calculating global meshing inputs. Selecting a higher resolution
generates a better quality mesh.

Type int

Read Only No

UsePredefinedSettings

Automatically calculates the global sizing values based on the resolution value.

Type bool

Read Only No

MolarMass
The Molar Mass model.

Can be applied to Fluid and Thermal analyses

Properties
Magnitude

Gets or sets the magnitude.

Type Expression<Quantity>

Read Only No

MoveRotateControl
The Configuration control to move or rotate the geometry to a new Reference Frame.

Properties
PartSelections

Part selection for suppression

Type LocationSet

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
634 of ANSYS, Inc. and its subsidiaries and affiliates.
RelativeTo

The target Reference Frame.

Type ReferenceFrame

Read Only No

Methods
GenerateConfigureControlCommand

Generates the output for a specific Configure Control.

OriginAndOrientationDefinitionMethod
Defines a reference frame from a local origin and 2 direction vectors

Properties
No Properties.

PhysicsCoupling
Provides the definition of a Physics Coupling Interface.

Properties
PhysicsRegion1

The source Physics Region for the Interface.

Type PhysicsRegion

Read Only No

RegionList1

The list of region names on the sources Physics Region that supply data.

Type String[]

Read Only No

RegionList2

Current used string type and not list

Type String[]

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 635
Study

Side1Location

This can be set to AllCouplingSourceFaces or it will get/set the display test of a boundary/selection set
in the Source solution.

Type string

Read Only No

Side2Locations

The target locations for the Interface.

Type LocationSet

Read Only No

PhysicsDefinition
Represents a physics solution.

Properties
CalculationType

The calculation type for the solution.

Type CalculationType

Read Only No

Methods
GetAllBoundaryConditions

Provides a list of all Boundary Conditions in this entity.

Return A list of DataReferences containing the requested Boundary Conditions.

Type DataReferenceSet

GetAllContacts

A query to return all Contact objects in the Solution.

Return A list of DataReferences containing the requested Contacts.

Type DataReferenceSet

GetAllObjects

GetAllObjects may be used to get all of the objects for the given search criteria.

Return A DataReferenceSet of all the Parent children objects of the given Type.

Type DataReferenceSet

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
636 of ANSYS, Inc. and its subsidiaries and affiliates.
Optional Arguments

SearchLocation The criteria to use to do the match for the SearchString. This can be Exact, BeginsWith,
Contains, or EndsWith and the default is Exact.

Type SearchPosition

Default Value Exact

SearchString A search string to filter the return Components for the requested Type.

Type string

Example
This example displays all of the objects in a default solution.

system1 = GetSystem(Name="Study")
solutionComponent1 = Study.CreateTask(
Name="Solution",
System=system1)
study1 = system1.GetContainer(ComponentName="Study")
solution1 = study1.GetSolution(Name="Solution")
for item in solution1.GetAllObjects():
print item

GetAllPhysicsRegions

A query to return all Physics Regions in the Solution.

Return A list of DataReferences containing the requested Physics Regions.

Type DataReferenceSet

GetBodiesOfUnknownPhysicsRegion

Gets a list of bodies that are not associated with a physics region.

Return A list of bodies that are not associated with any physics regions.

Type List<string>

Required Arguments

Model The DataReference of the model to lookup the bodies in.

Type DataReference

GetBodiesOfUnknownPhysicsRegionAndTotalBodyCount

Gets a list of bodies that are not associated with a physics region and also the total number of bodies.

Return Total count of bodies and a list of bodies that are not associated with any
physics regions.

Type Dictionary<long, List<string>>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 637
Study

Required Arguments

Model The DataReference of the model to lookup the bodies in.

Type DataReference

GetDuplicateMaterialAssignments

Provides the list of overlapping Material Assignments given an active Model.

Return A DataReferenceSet of the duplicate material assignments.

Type DataReferenceSet

Required Arguments

ActiveModel The DataReference of the model of interest.

Type DataReference

ReferenceTopologyType The ReferenceTopologyType of interest.

Type ReferenceTopologyType

GetMaterialAssignments

A query to return all Material Assignments in the Analysis.

Return A list of DataReferences with the requested Material Assignments.

Type DataReferenceSet

GetTopologyWithoutMaterial

Locates the topologies ( represented by their reference strings ) that currently don't have a material
assignment given an active Model.

Return A list of topology reference strings containing the names of the found
bodies.

Type List<string>

Required Arguments

ActiveModel The DataReference of the model of interest.

Type DataReference

ReferenceTopologyType The ReferenceTopologyType of interest.

Type ReferenceTopologyType

PhysicsOptions
The common set of Physics Options.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
638 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
No Properties.

PhysicsRegion
Specifies the type and location of the fundamental physics in the simulation.

Properties
Location

The location of the Physics Region.

Type LocationSet

Read Only No

PhysicsType

The physics type for the physics region.

Type PhysicsType

Read Only No

Methods
GetAllBoundaryConditions

Provides a list of all Boundary Conditions in this entity.

Return A list of DataReferences containing the requested Boundary Conditions.

Type DataReferenceSet

GetDuplicateMaterialAssignments

Provides the list of overlapping Material Assignments given an active Model.

Return A DataReferenceSet of the duplicate material assignments.

Type DataReferenceSet

Required Arguments

ActiveModel The DataReference of the model of interest.

Type DataReference

ReferenceTopologyType The ReferenceTopologyType of interest.

Type ReferenceTopologyType

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 639
Study

GetMaterialAssignments

A query to return all Material Assignments in the Analysis.

Return A list of DataReferences with the requested Material Assignments.

Type DataReferenceSet

GetTopologyWithoutMaterial

Locates the topologies ( represented by their reference strings ) that currently don't have a material
assignment given an active Model.

Return A list of topology reference strings containing the names of the found
bodies.

Type List<string>

Required Arguments

ActiveModel The DataReference of the model of interest.

Type DataReference

ReferenceTopologyType The ReferenceTopologyType of interest.

Type ReferenceTopologyType

Plane
The analytic definition of a flat plane where the Z axis is the normal direction.

Properties
ConstructionMethod

Method for constructing the plane.

Type PlaneConstructionMethod

Read Only No

Normal

Z axis of the plane

Type Vector3D

Read Only Yes

Origin

Origin of the plane.

Type Point3DUnited

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
640 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only Yes

ScopedBodies

Bodies which this plane is scoped to.

Type LocationSet

Read Only No

XAxis

X axis of the plane.

Type Vector3D

Read Only Yes

YAxis

Y axis of the plane.

Type Vector3D

Read Only Yes

PlaneFromPlaneDefinition
Definition type for defining a plane from another plane.

Properties
BasePlane

Plane to define from.

Type Plane

Read Only No

PlaneFromReferenceFrameDefinition
Definition type for defining a plane from a reference frame.

Properties
Plane

The reference frame axes used to define the plane.

Type PlaneOption

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 641
Study

ReferenceFrame

Reference Frame to define from.

Type ReferenceFrame

Read Only No

PlaneOriginAndOrientationDefinition
Definition type for defining a plane from an origin and 2 axes.

Properties
No Properties.

PlaneTransformation
Extension for plane offset and rotation

Properties
RotationAngle

Rotation angle about the rotation axis

Type Expression<Quantity>

Read Only No

Suppress

Flag to suppress the transformation

Type bool

Read Only No

Point
Point represented by local coordinates relative to a reference frame.

Properties
CalculationMethod

Calculation method for defining the point from geometry.

Type PointCalculationMethod

Read Only No

DefineBy

Method for defining the point.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
642 of ANSYS, Inc. and its subsidiaries and affiliates.
Type CoordinateInputMethod

Read Only No

Location

Location to define the point.

Type LocationSet

Read Only No

RelativeTo

Frame of reference for the point.

Type ReferenceFrame

Read Only No

PointDefinition
Collection of properties to define a UniversalPoint

Properties
CalculationMethod

Calculation method for defining the point from geometry

Type PointCalculationMethod

Read Only No

DefineBy

Method for defining the point

Type CoordinateInputMethod

Read Only No

Location

Location to define the point

Type LocationSet

Read Only No

RelativeTo

Frame of reference for the point

Type ReferenceFrame

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 643
Study

Read Only No

ReferenceFrame
Frame of reference for modeling and simulation data.

Properties
ConfigurationTransform

Transform relative to the global reference frame without motion

Type Transform4x4

Read Only Yes

DefinitionType

Reference frame definition type.

Type ReferenceFrameDefinitionType

Read Only No

EnablePivot

Flag to Enable/Disable the GUI "Pivot".

Type bool

Read Only No

ParentFrame

Parent reference frame.

Type ReferenceFrame

Read Only No

PreferredCoordinateType

Default coordinate type for points/vectors in this reference frame.

Type TripletType

Read Only No

ResultObject
Used to define and evaluate a quantitative result in an Analysis.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
644 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
CalculateAverage

Set to true if averages are to be calculated as part of the Result evaluation.

Type bool

Read Only No

Location

The Location over which the Result is to be evaluated.

Type LocationSet

Read Only No

RelativeTo

The Reference Frame which the result is relative to

Type ReferenceFrame

Read Only No

Variable

The solution variable to be displayed

Type Expression<Quantity>

Read Only No

Methods
Evaluate

Evaluates the Result's calculated and displayed values based on the current solution.

Results
The top-level object for a Results task.

Properties
CustomScaling

Deformation scaling setting for custom scaling

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 645
Study

Scaling

How much to deform the Results display

Type DeformationScaling

Read Only No

ResultSetParametersExtension
Parameters for Results

Properties
Mode

The mode number for a Modal analysis.

Type uint

Read Only No

PhaseAngle

The Phase Angle representation of a Complex result.

Type double

Read Only No

SetNumber

The set number for a multi-step analysis.

Type uint

Read Only No

ReverseAboutXTransform
Rotates about the X axis by 180 degrees.

Properties
Suppress

Suppress/Unsuppress the transform

Type bool

Read Only No

ReverseAboutYTransform
Rotates about the Y axis by 180 degrees

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
646 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Suppress

Suppress/Unsuppress the transform

Type bool

Read Only No

ReverseAboutZTransform
Rotates about the Z axis by 180 degrees

Properties
Suppress

Suppress/Unsuppress the transform

Type bool

Read Only No

RotationTransform
Rotates the matrix about a vector relative to the local reference frame.

Properties
RelativeToType

Define the axis direction relative to Local or Parent.

Type RelativeToType

Read Only No

RotationAngle

Angle to rotate by.

Type Expression<Quantity>

Read Only No

Suppress

Suppress/Unsuppress the transform

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 647
Study

SelectionSet
An object that can be used to reference any Location.

Properties
Location

The selected location: evaluates to a set of reference ids. See LocationSet for more detail.

Type LocationSet

Read Only No

Methods
GetSelectionSetNodeCount

Returns the number of nodes of the specified SelectionSet.

Return The number of nodes of the specified SelectionSet.

Type uint

GetSelectionSetSelectableEntityCount

Returns the number of selectable entities of the specified SelectionSet.

Return The number of selectable entities of the specified SelectionSet.

Type uint

Simulation
The top-level object that manages all data in a simulation study.

Properties
No Properties.

Methods
GetAllModels

A query to return all available models in the Simulation.

Return A list of DataReferences containing the requested Models.

Type DataReferenceSet

GetObjectsForReference

A query to get all data objects in the simulation which reference the topological entity with the given
reference ID.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
648 of ANSYS, Inc. and its subsidiaries and affiliates.
Return The list of data objects that references the given input Reference string.

Type List<DataReference>

Required Arguments

Reference The toplogical entities reference string such as "BODY1", "FACE16", etc

Type string

SingleValueResult
A result object that can be used to evaluate a single calculated value.

Properties
CalculateAverage

Set to true if averages are to be calculated as part of the Result evaluation.

Type bool

Read Only No

Condition

The boolean condition used in CountIf and SumIf expressions

Type string

Read Only No

Expression

An expression to be calculated.

Type Expression<Quantity>

Read Only No

Function

The function used to calculate the value.

Type string

Read Only No

Location

The Location over which the Result is to be evaluated.

Type LocationSet

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 649
Study

MeshEntity

Specifies the type of mesh location (node, element, face, edge) to be used to calculate the value.

Type EntityType

Read Only No

Method

The method by which the value is calculated.

Type Method

Read Only No

RelativeTo

The Reference Frame which the result is relative to

Type ReferenceFrame

Read Only No

Value

The current value of the result.

Type Quantity

Read Only No

Variable

The solution variable to be displayed

Type Expression<Quantity>

Read Only No

WeightType

The weight method used to calculate an average value.

Type WeightingType

Read Only No

SolutionQualityMonitor
Solution quality monitor objects are used to present graphical charts tracking aspects of the solution
quality, such as convergence.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
650 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Component

For non-scalar Solution Quality Metrics, defines the component

Type string

Read Only No

Location

For scoped Solution Quality Metrics, defines the location

Type LocationSet

Read Only No

MonitorTypeName

Gives a type of Solution Quality Metric

Type string

Read Only No

SolverSettings
The common set of solver settings.

Properties
No Properties.

SpecificHeatConstantPressure
The specific heat at constant pressure model provided via a specified expression.

Properties
Magnitude

The Magnitude is an expresion which evaluates to a Quantity with the correct units.

Type Expression<Quantity>

Read Only No

SphericalTriplet
Triplet represented in spherical coordinates

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 651
Study

Properties
Phi

Angle in the XY plane counter-clockwise from the +X axis (a.k.a phi) phi = arctan(y / x)

Type Expression<Quantity>

Read Only No

Distance from the origin r = sqrt(x^2 + y^2 + z^2)

Type Expression<Quantity>

Read Only No

Theta

Angle between the +Z axis and the vector (a.k.a. polar angle, theta) theta = arccos(z / r)

Type Expression<Quantity>

Read Only No

StreamLine
A result that displays flow paths within a vector field.

Properties
AnimationDuration

The total length of time the animation takes to execute.

Type Quantity

Read Only No

Direction

The integration direction to create streamlines.

Type DirectionType

Read Only No

Distribution

The method used to distribute seed points.

Type SeedPointDistributionType

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
652 of ANSYS, Inc. and its subsidiaries and affiliates.
EndTime

The maximum integration time of streamlines.

Type Quantity

Read Only No

EndTimeFactor

The amount my which the maximum integration time is scaled when creating animated streamlines.

Type float

Read Only No

FadeLineSegments

Controls if line segments fade towards the end.

Type bool

Read Only No

FixedStepSize

The size of integration steps in streamline creation when using a fixed step size.

Type float

Read Only No

Location

The Location over which the Result is to be evaluated.

Type LocationSet

Read Only No

MeshDistribution

Defines how the mesh is sampled to create seed points.

Type SeedPointMeshDistributionType

Read Only No

NSteps

The maximum number of integration steps in streamline creation.

Type uint

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 653
Study

RibbonWidth

The width of streamline ribbon display.

Type double

Read Only No

SegmentRatio

The length of segments when displaying dashed streamlines.

Type float

Read Only No

SkipFactor

How many nodes or elements are skipped when sampling mesh to generate seed points.

Type uint

Read Only No

StepSize

The method used to determine the size of integration steps in streamline creation.

Type StepSizeType

Read Only No

StreamLineColorOption

How the streamline is colored.

Type StreamlineColorOption

Read Only No

StreamLineDisplayStyle

Controls the display style of the streamlines.

Type StreamLineDisplayStyle

Read Only No

StreamLineShape

The line display style for the streamlines.

Type StreamLineShapeDef

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
654 of ANSYS, Inc. and its subsidiaries and affiliates.
StreamLineStyle

THe streamline line style.

Type StreamLineStyle

Read Only No

SymbolScaleFactor

The size factor of streamline symbols.

Type double

Read Only No

SymbolSegmentDensity

The number of symbols and segments per streamline

Type int

Read Only No

SymbolShape

The symbol used on streamline display.

Type SymbolShape

Read Only No

TubeDiameter

The diameter of streamline tube display.

Type double

Read Only No

UniformDistributionSize

The target number of seed points.

Type uint

Read Only No

Variable

The vector variable used to create the streamlines.

Type Expression<Quantity>

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 655
Study

VolumetricGridSpacing

The spacing of uniform grid sampling.

Type Quantity

Read Only No

WireThickness

The thickness of streamline wire display.

Type double

Read Only No

SummaryParametersExtension
Summary of Result values

Properties
Average

The calculated average of the Quantity of interest.

Type Quantity

Read Only Yes

Max

The calculated maximum value of the Quantity in this Result.

Type Quantity

Read Only Yes

Min

The calculated minimum value of the Quantity in this Result.

Type Quantity

Read Only Yes

Sum

The calculated Sum total of the Quantity being evaluated in this Result.

Type Quantity

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
656 of ANSYS, Inc. and its subsidiaries and affiliates.
SumX

The calculated Sum total of the X-component of the Quantity evaluated in this Result.

Type Quantity

Read Only Yes

SumY

The calculated Sum total of the Y-component of the Quantity evaluated in this Result.

Type Quantity

Read Only Yes

SumZ

The calculated Sum total of the Z-component of the Quantity evaluated in this Result.

Type Quantity

Read Only Yes

SuppressControl
Settings for the suppression of geometry or mesh in a Configuration.

Properties
PartSelections

Part selection for suppression

Type LocationSet

Read Only No

Methods
GenerateConfigureControlCommand

Generates the output for a specific Configure Control.

SutherlandThreeCoefficientDefinition
The three coefficient model definition.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 657
Study

Type string

Read Only No

EffectiveTemperature

Gets or sets the effective temperature.

Type Expression<Quantity>

Read Only No

ReferenceTemperature

Gets or sets the reference temperature.

Type Expression<Quantity>

Read Only No

ReferenceViscosity

Gets or sets the reference viscosity.

Type Expression<Quantity>

Read Only No

SutherlandTwoCoefficientDefinition
The two coefficient model definition

Properties
CoefficientC1

Gets or sets the coefficient c1.

Type Expression<Quantity>

Read Only No

CoefficientC2

Gets or sets the coefficient c2.

Type Expression<Quantity>

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
658 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

ThreeCoefficientDefinition
The three coefficient definition

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

ReferenceTemperature

Gets or sets the reference temperature.

Type Expression<Quantity>

Read Only No

ReferenceViscosity

Gets or sets the reference viscosity.

Type Expression<Quantity>

Read Only No

TemperatureExponent

Gets or sets the temperature exponent.

Type Expression<Quantity>

Read Only No

Transcript
Controls the contents of a Transcript monitor.

Properties
Filename

The name of the file to be monitored in a Transcript.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 659
Study

SourceType

The data source for the Transcript monitor.

Type TranscriptType

Read Only No

TranslationTransform
Translates a reference frame by a vector.

Properties
RelativeToType

Define the translation vector relative to Local or Parent. This is a simplification of the TranslationVector
RelativeTo property

Type RelativeToType

Read Only No

Suppress

Suppress/Unsuppress the transform

Type bool

Read Only No

TwoCoefficientDefinition
The two coefficient definition.

Properties
DimensionalCoefficientB

Gets or sets the dimensional coefficient B.

Type Expression<Quantity>

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
660 of ANSYS, Inc. and its subsidiaries and affiliates.
TemperatureExponent

Gets or sets the temperature exponent.

Type Expression<Quantity>

Read Only No

UniversalTriplet
Representation of a point or vector in cartesian, cylindrical, and spherical coordinates

Properties
CoordinateType

The type of coordinate: Cartesian, Cylindrical, or Spherical

Type TripletType

Read Only No

UniversalVectorDefinition
Collection of properties to define a UniversalVector

Properties
CalculationMethod

Calculation method for defining the vector from geometry

Type VectorCalculationMethod

Read Only No

DefineBy

Method for defining the vector

Type CoordinateInputMethod

Read Only No

Location

Location to define the vector

Type LocationSet

Read Only No

Magnitude

Magnitude of the vector

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 661
Study

Type Expression<Quantity>

Read Only No

RelativeTo

Frame of reference for the vector

Type ReferenceFrame

Read Only No

ReverseDirection

Flag to reverse the vector direction when defining from Geometry

Type bool

Read Only No

VectorDefineBy

Define the vector from magnitude/direction or components

Type UniversalVectorDefineBy

Read Only No

VectorResult
A result object that displays the magnitude and direction of a vector field.

Properties
CalculateAverage

Set to true if averages are to be calculated as part of the Result evaluation.

Type bool

Read Only No

Distribution

The method for defining vector seed points.

Type SeedPointDistributionType

Read Only No

Location

The Location over which the Result is to be evaluated.

Type LocationSet

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
662 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

MeshDistribution

Defines how the mesh is sampled to create seed points.

Type SeedPointMeshDistributionType

Read Only No

RelativeTo

The Reference Frame which the result is relative to

Type ReferenceFrame

Read Only No

SkipFactor

How many nodes or elements are skipped when sampling mesh to generate seed points.

Type uint

Read Only No

SymbolLength

Controls how symbol length is determined.

Type SymbolLengthOptions

Read Only No

SymbolScaleFactor

The scale factor for symbol size.

Type double

Read Only No

SymbolShape

The symbol to be used to display the vectors.

Type SymbolShape

Read Only No

UniformDistributionSize

The maximum number of symbols to be displayed.

Type uint

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 663
Study

Read Only No

Variable

The solution variable to be displayed

Type Expression<Quantity>

Read Only No

VolumetricGridSpacing

The spacing of uniform grid sampling.

Type Quantity

Read Only No

VirtualPrimitiveBox
This class represents box.

Properties
CreateSelectionSets

Flag to enable/disable selection set creation

Type bool

Read Only No

VirtualPrimitiveBoxConstraint
This class extends VirtualPrimitiveBox class. Contains properties like Selection Method, Cushioning,
Location etc.

Properties
CushionXminus

Gets or sets the -X cushion value for non-uniform cushion.

Type Expression<Quantity>

Read Only No

CushionXplus

Gets or sets the +X cushion value for non-uniform cushion.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
664 of ANSYS, Inc. and its subsidiaries and affiliates.
CushionYminus

Gets or sets the -Y cushion value for non-uniform cushion.

Type Expression<Quantity>

Read Only No

CushionYplus

Gets or sets the +Y cushion value for non-uniform cushion.

Type Expression<Quantity>

Read Only No

CushionZminus

Gets or sets the -Z cushion value for non-uniform cushion.

Type Expression<Quantity>

Read Only No

CushionZplus

Gets or sets the +Z cushion value for non-uniform cushion.

Type Expression<Quantity>

Read Only No

EntitiesInSelection

Gets or sets the entites to be enclosed.

Type LocationSet

Read Only No

SelectionMethod

Gets or sets the options for choosing between box creation methods.

Type PrimitiveBoxCreationMethod

Read Only No

TypeOfCushion

Gets or sets the option to select between Uniform or Non-Uniform cushion around box.

Type BoxCushionType

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 665
Study

UniformCushionValue

Gets or sets the uniform cushion value for uniform cushion.

Type Expression<Quantity>

Read Only No

Viscosity
The viscosity model provided via a specified expression.

Properties
Magnitude

The Magnitude is an expresion which evaluates to a Quantity with the correct units.

Type Expression<Quantity>

Read Only No

ViscosityCarreauShearAndTemperatureDependent
The Shear Rate and Temperature dependent model.

Properties
ActivationEnergy

Gets or sets the activation energy.

Type Expression<Quantity>

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

InfiniteShearViscosity

Gets or sets the infinite shear viscosity.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
666 of ANSYS, Inc. and its subsidiaries and affiliates.
PowerLawIndex

Gets or sets the index of the power law.

Type Expression<Quantity>

Read Only No

ReferenceTemperature

Gets or sets the reference temperature.

Type Expression<Quantity>

Read Only No

TimeConstant

Gets or sets the time constant.

Type Expression<Quantity>

Read Only No

ZeroShearViscosity

Gets or sets the zero shear viscosity.

Type Expression<Quantity>

Read Only No

ViscosityCarreauShearRateDependent
The Shear Rate dependent model.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

InfiniteShearViscosity

Gets or sets the infinite shear viscosity.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 667
Study

PowerLawIndex

Gets or sets the index of the power law.

Type Expression<Quantity>

Read Only No

TimeConstant

Gets or sets the time constant.

Type Expression<Quantity>

Read Only No

ZeroShearViscosity

Gets or sets the zero shear viscosity.

Type Expression<Quantity>

Read Only No

ViscosityCrossShearAndTemperatureDependent
The Shear Rate and Temperature Dependent model.

Properties
ActivationEnergy

Gets or sets the activation energy.

Type Expression<Quantity>

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

PowerLawIndex

Gets or sets the index of the power law.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
668 of ANSYS, Inc. and its subsidiaries and affiliates.
ReferenceTemperature

Gets or sets the reference temperature.

Type Expression<Quantity>

Read Only No

TimeConstant

Gets or sets the time constant.

Type Expression<Quantity>

Read Only No

ZeroShearViscosity

Gets or sets the zero shear viscosity.

Type Expression<Quantity>

Read Only No

ViscosityCrossShearRateDependent
The Shear Rate Dependent model.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

PowerLawIndex

Gets or sets the index of the power law.

Type Expression<Quantity>

Read Only No

TimeConstant

Gets or sets the time constant.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 669
Study

ZeroShearViscosity

Gets or sets the zero shear viscosity.

Type Expression<Quantity>

Read Only No

ViscosityHerschelBulkleyShearAndTemperatureDependent
The Shear Rate and Temperature dependent model.

Properties
ActivationEnergy

Gets or sets the activation energy.

Type Expression<Quantity>

Read Only No

ConsistencyIndex

Gets or sets the index of the consistency.

Type Expression<Quantity>

Read Only No

CriticalShearRate

Gets or sets the critical shear rate.

Type Expression<Quantity>

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

PowerLawIndex

Gets or sets the index of the power law.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
670 of ANSYS, Inc. and its subsidiaries and affiliates.
ReferenceTemperature

Gets or sets the reference temperature.

Type Expression<Quantity>

Read Only No

YieldStressThreshold

Gets or sets the yield stress threshold.

Type Expression<Quantity>

Read Only No

ViscosityHerschelBulkleyShearRateDependent
The Shear Rate dependent model.

Properties
ConsistencyIndex

Gets or sets the index of the consistency.

Type Expression<Quantity>

Read Only No

CriticalShearRate

Gets or sets the critical shear rate.

Type Expression<Quantity>

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

PowerLawIndex

Gets or sets the index of the power law.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 671
Study

YieldStressThreshold

Gets or sets the yield stress threshold.

Type Expression<Quantity>

Read Only No

ViscosityNonNewtonianPowerLawShearAndTemperatureDependent
The Shear Rate and Temperature dependent model.

Properties
ActivationEnergy

Gets or sets the activation energy.

Type Expression<Quantity>

Read Only No

ConsistencyIndex

Gets or sets the index of the consistency.

Type Expression<Quantity>

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

MaximumViscosityLimit

Gets or sets the maximum viscosity limit.

Type Expression<Quantity>

Read Only No

MinimumViscosityLimit

Gets or sets the minimum viscosity limit.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
672 of ANSYS, Inc. and its subsidiaries and affiliates.
PowerLawIndex

Gets or sets the index of the power law.

Type Expression<Quantity>

Read Only No

ReferenceTemperature

Gets or sets the reference temperature.

Type Expression<Quantity>

Read Only No

ViscosityNonNewtonianPowerLawShearRateDependent
The Shear Rate dependent model

Properties
ConsistencyIndex

Gets or sets the index of the consistency.

Type Expression<Quantity>

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

MaximumViscosityLimit

Gets or sets the maximum viscosity limit.

Type Expression<Quantity>

Read Only No

MinimumViscosityLimit

Gets or sets the minimum viscosity limit.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 673
Study

PowerLawIndex

Gets or sets the index of the power law.

Type Expression<Quantity>

Read Only No

VolumeExtractionRegion
Volume Extraction Region specifies the settings used when extracting a volume region for a wrap task.

Available options:

GeometryLocation Specifies the surounding bodies around the

volume to be extracted.
Point Specifies a reference point where the volume
is located to extact.
ExtraRefineLevel Specifies number of extra refinement levels.
ImprintIterations Specifies number of imprinting iterations for
feature capturing.
AggressiveImprintIterations Specifies additional iterations for aggressive
imprinting to improve feature capture.

Properties
FeatureResolution

Sets the Feature Resolution factor to be used for all Mesh Regions.

Type double

Read Only No

Location

A common property for all sub meshing objects with a defined Geometry Filter

Type LocationSet

Read Only No

Point

Specifies a reference point for where the volume to extract is located.

Type Point

Read Only No

RegionBehavior

Specifies the meshing region behavior.

Available options:

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
674 of ANSYS, Inc. and its subsidiaries and affiliates.
 Wrap Simplifies unclean geometry before sewing.
PassThroughToSew Bypasses simplification of unclean geometry
before sewing.

Type RegionBehavior

Read Only No

UseAutomaticallyDefinedLocation

A common toggle for all sub meshing objects with a Location property so that it can be automatically
set. Currently only visible in Inflation object.

Type bool

Read Only No

WrapMethod

Specifies wrap method for the meshing region.

Available options:

ShrinkWrap
CutWrap

Type WrapMethod

Read Only No

VolumeSimplificationRegion
Volume Simplification specifies the settings used when simplifying a model within a wrap task.

Available options:

GeometryLocation Specifies the bodies and parts to be wrapped.

GroupingOption Specifies grouping option for the bodies being
wrapped.
ExtraRefineLevel Specifies number of extra refinement levels.
ImprintIterations Specifies number of imprinting iterations for
feature capturing.
AggressiveImprintIterations Specifies additional iterations for aggressive
imprinting to improve feature capture.

Properties
FeatureResolution

Sets the Feature Resolution factor to be used for all Mesh Regions.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 675
Study

Location

A common property for all sub meshing objects with a defined Geometry Filter

Type LocationSet

Read Only No

MergeBodies

If checked, geometry is simplified by unifying multiple solid surfaces into one and ignoring any interior
voids and faces. Otherwise, a conformal, well-connected surface mesh is created for each of the selected
bodies.

Type bool

Read Only No

RegionBehavior

Specifies the meshing region behavior.

Available options:

Wrap Simplifies unclean geometry before sewing.

PassThroughToSew Bypasses simplification of unclean geometry
before sewing.

Type RegionBehavior

Read Only No

UseAutomaticallyDefinedLocation

A common toggle for all sub meshing objects with a Location property so that it can be automatically
set. Currently only visible in Inflation object.

Type bool

Read Only No

WrapMethod

Specifies wrap method for the meshing region.

Available options:

ShrinkWrap
CutWrap

Type WrapMethod

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
676 of ANSYS, Inc. and its subsidiaries and affiliates.
Wrap
Volume creation task uses specialized boundary wrapping to extract a well-connected surface mesh for
the selected geometry.

Properties
MeshResolution

Defines the resolution for automatically calculating global meshing inputs. Selecting a higher resolution
generates a better quality mesh.

Type int

Read Only No

Reassociate

Specifies whether the current output model should be used for reassociating so that reference Ids are
persistent or whether new references should be created.

Type bool

Read Only No

UsePredefinedSettings

Automatically calculates the global sizing values based on the resolution value.

Type bool

Read Only No

Fluids Data Entities

AbsorptionCoefficientModel
Configure parameters for absorption coefficient in radiation heat transfer.

Properties
MaterialAbsorptionCoefficient

Specify absorption coefficient for radiation heat transfer.

Type IDictionary<string, Object>

Read Only No

PathLength

Set path length.

Type Expression<Quantity>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 677
Study

Read Only No

Absorptivity
Set absorptivity parameters.

Properties
DiffuseHemispherical

Specify diffuse hemispherical absorptivity.

Type Expression<Quantity>

Read Only No

DirectIR

Specify direct infra-red absorptivity.

Type Expression<Quantity>

Read Only No

DirectVisible

Specify direct visible absorptivity.

Type Expression<Quantity>

Read Only No

Acoustics
Set the acoustics initial conditions.

Properties
AcousticPressure

Set the acoustic pressure value.

Type Expression<Quantity>

Read Only No

AcousticVelocity

Set the velocity direction in different coordinate system.

Type AcousticVelocity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
678 of ANSYS, Inc. and its subsidiaries and affiliates.
AcousticVelocity
Set the velocity direction in different coordinate system.

Properties
CartesianVelocityComponents

Set the velocity component in Cartesian coordinate system.

Type List<Expression<Quantity>>

Read Only No

CylindricalVelocityComponents

Set the velocity component in cylindrical coordinate system.

Type List<Expression<Quantity>>

Read Only No

AdvancementControl
Configure advance control setting for solver.

Properties
EnergyControl

Configure solution advancement process for energy.

Type EnergyControl

Read Only No

FlowControl

Configure solution advancement process for momentum.

Type FlowControl

Read Only No

RadiationControl

Configure solution advancement process for radiation.

Type IDictionary<string, Object>

Read Only No

SpeciesControl

Configure solution advancement process for species.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 679
Study

Type IDictionary<string, Object>

Read Only No

TurbulenceControl

Configure solution advancement process for turbulence.

Type IDictionary<string, Object>

Read Only No

UseCommonSpeciesSetting

Enables to use same settings for all the species.

Type bool

Read Only No

UserVariableControl

Configure solution advancement process for user variable.

Type IDictionary<string, Object>

Read Only No

Advection
Configure advection schemes for governing equations

Properties
AdvectionDefaultSetting

Select default advection scheme so that all equations except those of turbulence default to it

Type Option

Possible Values: FirstOrderUpwind

QUICK
SecondOrderUpwind
ThirdOrderMUSCL
UnboundedSecondOrderUpwind

Read Only No

AdvectionEquation

Configure advection scheme

Type IDictionary<string, Object>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
680 of ANSYS, Inc. and its subsidiaries and affiliates.
BlendFactor

Specify blend factor

Type Expression<Quantity>

Read Only No

FirstToHigherOrderBlending

Turn on first to higher order order blending.

Type bool

Read Only No

AFDPhysicsOptions
Configure physics options for fluid flow physics.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

AllowReverseFlow
Configure reverse flow for the boundary.

Properties
BackflowDirection

Sets the direction of the inflow stream should the flow reverse direction. If you choose Direction Vector,
you will define the flow direction components, and if you choose Normal to Boundary or From Neigh-
boring Cell, no inputs are required.

Type BackflowDirection

Read Only No

BackflowPressureSpecification

Select the option to specify the backflow pressure.

Type BackflowPressureSpecification

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 681
Study

Option

Enable/Disable reverse flow.

Type Option

Possible Values: No
Yes

Read Only No

AngularDiscretization
Configure parameters for angular discretization and pixelation for the DO mode.

Properties
PhiDivisions

Set Phi Divisions, which is the number of control angles used to discretize each octant of the angular
space.

Type int

Read Only No

PhiPixels

Set Phi Pixels, which is used to control the pixelation that accounts for any control volume overhang.

Type int

Read Only No

ThetaDivisions

Set Theta Divisions, which is the number of control angles used to discretize each octant of the angular
space.

Type int

Read Only No

ThetaPixels

Set Theta Pixels, which is used to control the pixelation that accounts for any control volume overhang.

Type int

Read Only No

Axis
Set the axis for reference frame or direction specification.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
682 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
CartesianDirection

Set the direction specification in Cartesian coordinates.

Type List<Expression<double>>

Read Only No

Option

Set the axis for reference frame or direction specification.

Type Option

Possible Values: DomainAxis

PointAndDirection

Read Only No

Point1

Set the position vector for point.

Type List<Expression<Quantity>>

Read Only No

BackflowDirection
Sets the direction of the inflow stream should the flow reverse direction. If you choose Direction Vector,
you will define the flow direction components, and if you choose Normal to Boundary or From Neigh-
boring Cell, no inputs are required.

Properties
CartesianDirectionComponents

Set the component in the different direction.

Type List<Expression<Quantity>>

Read Only No

CylindricalDirectionComponents

Set the component in the different direction.

Type List<Expression<Quantity>>

Read Only No

Option

Select option for backflow direction specification.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 683
Study

Type Option

Possible Values: Cartesian

Cylindrical
FromNeighboringCell
NormalToBoundary

Read Only No

BackflowPressureSpecification
Select the option to specify the backflow pressure.

Properties
Option

Select option for backflow pressure specification.

Type Option

Possible Values: EntrainmentPressure

TotalPressure

Read Only No

TotalPressureFrame

Select reference frame for total pressure

Type TotalPressureFrame

Read Only No

BeamDirection
Configure radiation beam direction.

Properties
Option

Choose a beam direction from the available options.

Type Option

Possible Values: SpecifiedValue

UseSolarLoadModelSetting

Read Only No

Value

Specify beam direction vector.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
684 of ANSYS, Inc. and its subsidiaries and affiliates.
Type List<Expression<double>>

Read Only No

BeamWidth
Set beam width for an external semi-transparent wall in terms of the Theta and Phi extents.

Properties
Phi

Set Phi.

Type Expression<double>

Read Only No

Theta

Set Theta.

Type Expression<double>

Read Only No

Boundary
Set boundary.

Properties
BoundaryLocations

Set the boundary location.

Type List<string>

Read Only No

BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type BoundaryReferenceFrame

Read Only No

BoundaryType

Set different boundary type.

Type Option

Possible Values: Axis

Farfield

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 685
Study

Inlet
Opening
Outlet
Symmetry
Wall

Read Only No

Energy

Set boundary conditions related to Energy.

Type Energy

Read Only No

Flow

Configure flow specification for the boundary.

Type Flow

Read Only No

ParticleBoundaryConditions

to be documented

Type ParticleBoundaryConditions

Read Only No

Radiation

Configure radiation specifications for boundary.

Type Radiation

Read Only No

Regime

Configure flow regime.

Type Regime

Read Only No

Turbulence

Set turbulence related boundary conditions in the model.

Type Turbulence

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
686 of ANSYS, Inc. and its subsidiaries and affiliates.
UserScalarBoundaryConditions

to be documented

Type IDictionary<string, Object>

Read Only No

UserVectorBoundaryConditions

to be documented

Type IDictionary<string, Object>

Read Only No

BoundaryReferenceFrame
Set the reference frame for boundary from (physics region or all available reference frames).

Properties
FrameName

Select a frame from the defined reference frames.

Type DataObject

Read Only No

Option

Set the reference frame for boundary from (physics region or all available reference frames).

Type Option

Possible Values: SpecifyFrame

UseFromPhysicsRegion

Read Only No

CalculationControl
Configure calculation specific settings.

Properties
IterationControl

Configure settings for iteration control.

Type IterationControl

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 687
Study

ResidualControl

Configure settings to control residual information.

Type ResidualControl

Read Only No

SolutionMonitorControl

Configure settings for solution monitor control.

Type IDictionary<string, Object>

Read Only No

Clustering
Configure methods and settings for creating surface clusters.

Properties
FacesPerSurfaceCluster

sets the number of faces per surface cluster for the wall.

Type int

Read Only No

MaximumDistanceFromCriticalZone

Set maximum distance of a zone form a critical zone for which view factors will be calculated.

Type Expression<Quantity>

Read Only No

MaximumFacesPerSurfaceCluster

Set Maximum Faces Per Surface Cluster, which is maximum number of faces per surface cluster auto-
matically assigned to non-critical wall zones adjacent to fluid zones.

Type int

Read Only No

Components
Allows to specify the velocity component in different coordinate system.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
688 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
CartesianVelocityComponents

Set the velocity component in Cartesian coordinate system.

Type List<Expression<Quantity>>

Read Only No

CylindricalVelocityComponents

Set the velocity component in cylindrical coordinate system.

Type List<Expression<Quantity>>

Read Only No

Option

Allows to specify the velocity component in different coordinate system.

Type Option

Possible Values: Cartesian

Cylindrical

Read Only No

ConnectionType
Choose connection type for interface.

Properties
PeriodicityType

Choose periodicity type.

Type PeriodicityType

Read Only No

ConvergenceCriteria
Configure convergence criteria for residual, monitor, etc.

Properties
ImbalanceConvergence

Configure imbalance convergence.

Type ImbalanceConvergence

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 689
Study

Read Only No

MonitorConvergence

Set convergence criteria for monitors.

Type MonitorConvergence

Read Only No

ResidualConvergence

Configure convergence criteria for residuals.

Type ResidualConvergence

Read Only No

UserDefinedConvergence

Create user defined convergence.

Type UserDefinedConvergence

Read Only No

CoupledControls
Configure coupled controls.

Properties
FixedCycleControls

Configure parameters that control the V, W and F cycles.

Type FixedCycleControls

Read Only No

CouplingControl
Configure settings for solution advancement.

Properties
FlowCoupling

Allows to choose solver formulations for density based solver.

Type FlowCoupling

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
690 of ANSYS, Inc. and its subsidiaries and affiliates.
PressureVelocityCoupling

Allows to choose different schemes for pressure-velocity coupling.

Type PressureVelocityCoupling

Read Only No

UseImplicitBodyForce

Enable implicit body force treatment to take pressure gradient and body forces into account.

Type bool

Read Only No

VolumeFractionCoupling

Enable coupling of volume fraction, velocity corrections and shared pressure corrections simultaneously.

Type bool

Read Only No

DampingZone
Define how the Damping layer must behave.

Properties
MaximumDamping

Set the maximum damping of the damping layer.

Type Expression<Quantity>

Read Only No

Thickness

Set the thickness of the damping layer, starting from the NRBC.

Type Expression<Quantity>

Read Only No

DateAndTime
Configure parameters to specify date and time.

Properties
DayOfYear

Configure parameters to specify day and month.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 691
Study

Type DayOfYear

Read Only No

TimeOfDay

Configure parameters to specify hour and minutes.

Type TimeOfDay

Read Only No

DayOfYear
Configure parameters to specify day and month.

Properties
Day

Set parameters to specify day

Type int

Read Only No

Month

Set parameters to specify month.

Type int

Read Only No

DesModel
Specifies turbulent flow to be calculated using the Detached Eddy Simulation model.

Properties
ShieldingFunction

Choose among the shielding functions.

Type Option

Possible Values: DDES

IDDES
SSTF1
SSTF2

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
692 of ANSYS, Inc. and its subsidiaries and affiliates.
DiffuseSolarIrradiation
Configure Diffuse Solar Irradiation, which is the amount of energy per unit area due to diffuse solar ir-
radiation.

Properties
Value

Specify the value

Type Expression<Quantity>

Read Only No

Direction
Allows to choose between Cartesian or cylindrical component to specify direction.

Properties
CartesianVectorComponents

Set the vector component in Cartesian coordinate system.

Type List<Expression<Quantity>>

Read Only No

CylindricalVectorComponents

Set the vector component in cylindrical coordinate system.

Type List<Expression<Quantity>>

Read Only No

Option

Allows to choose between Cartesian or cylindrical component to specify direction.

Type Option

Possible Values: CartesianComponents

CylindricalComponents

Read Only No

DirectSolarIrradiation
Configure Direct Solar Irradiation, which is the amount of energy per unit area due to direct solar irra-
diation.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 693
Study

Properties
Value

Specify the value, default is 0

Type Expression<Quantity>

Read Only No

DiscretizationControl
Configure conversion of scalar transport equations to discrete algebraic equations

Properties
SpatialDiscretization

Configure interpolation of convection terms of quantities to control volumes

Type SpatialDiscretization

Read Only No

EARSMRgKEpsilonModelConstants
Configure K-Epsilon model constants.

Properties
C1_0

Set model constant.

Type Expression<double>

Read Only No

C1_1

Set model constant.

Type Expression<double>

Read Only No

C2

Set model constant.

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
694 of ANSYS, Inc. and its subsidiaries and affiliates.
C2TurbulenceDissipationRate

Set constant used in the transport equation.

Type Expression<double>

Read Only No

C3

Set model constant.

Type Expression<double>

Read Only No

C4

Set model constant.

Type Expression<double>

Read Only No

Cmu

Set model constant.

Type Expression<Quantity>

Read Only No

TurbulenceDissipationRatePrandtlNumber

Set Effective Prandtl number for transport of the turbulent dissipation rate.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyPrandtlNumber

Set Effective Prandtl number for transport of turbulence kinetic energy.

Type Expression<double>

Read Only No

EARSMRgKOmegaBSLModelConstants
Configure KOmega BSL model constants.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 695
Study

Properties
Betai1

Constant used in dissipation of Omega.

Type Expression<double>

Read Only No

Betai2

Constant used in dissipation of Omega.

Type Expression<double>

Read Only No

BetaStarInfinite

Constant used in modeling the Turbulence Dissipation.

Type Expression<double>

Read Only No

C1_0

Set model constant.

Type Expression<double>

Read Only No

C1_1

Set model constant.

Type Expression<double>

Read Only No

C2

Set model constant.

Type Expression<double>

Read Only No

C3

Set model constant.

Type Expression<double>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
696 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

C4

Set model constant.

Type Expression<double>

Read Only No

Ceps1

Set C-epsilon1 for EARSMRg K-Omega Mean Base Line (BSL) Model.

Type Expression<double>

Read Only No

Ceps2

Set C-epsilon1 for EARSMRg K-Omega Mean Base Line (BSL) Model.

Type Expression<double>

Read Only No

Cmu

Set model constant.

Type Expression<Quantity>

Read Only No

TurbulenceEddyFrequencyPrandtlNumber1

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency
(omega) condition.

Type Expression<double>

Read Only No

TurbulenceEddyFrequencyPrandtlNumber2

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency
(omega) condition.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyPrandtlNumber1

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of
turbulence kinetic energy via turbulent transport.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 697
Study

Type Expression<double>

Read Only No

TurbulenceKineticEnergyPrandtlNumber2

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of
turbulence kinetic energy via turbulent transport.

Type Expression<double>

Read Only No

EARSMRgKOmegaModelConstants
Configure Rumsey Gatski KOmega model constants.

Properties
AlphaInfinite

Set coefficient used in the Production of Omega.

Type Expression<double>

Read Only No

AlphaStarInfinite

Set model constant.

Type Expression<double>

Read Only No

Beta

Set model constant Beta.

Type Expression<double>

Read Only No

BetaStarInfinite

Set constant used in modeling the Turbulence Dissipation.

Type Expression<double>

Read Only No

C1_0

Set model constant.

Type Expression<double>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
698 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

C1_1

Set model constant.

Type Expression<double>

Read Only No

C2

Set model constant.

Type Expression<double>

Read Only No

C2TurbulenceEddyFrequency

Set model constant.

Type Expression<double>

Read Only No

C3

Set model constant.

Type Expression<double>

Read Only No

C4

Set model constant.

Type Expression<double>

Read Only No

Cmu

Set model constant.

Type Expression<Quantity>

Read Only No

Cs

Set Smagorinsky constant.

Type Expression<double>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 699
Study

Read Only No

Gamma

Set model constant Gamma.

Type Expression<double>

Read Only No

Mt0

Set Compressibility Correction.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyPrandtlNumber

Set model constant.

Type Expression<double>

Read Only No

ZetaStar

Set model constant used in the Turbulence Dissipation.

Type Expression<double>

Read Only No

EARSMWjKOmegaBSLModelConstants
Configure KOmega BSL model constants.

Properties
A1

Set model constant.

Type Expression<double>

Read Only No

A3

Set model constant.

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
700 of ANSYS, Inc. and its subsidiaries and affiliates.
A4

Set model constant.

Type Expression<double>

Read Only No

AlphaInfinite

Set coefficient used in the Production of Omega.

Type Expression<double>

Read Only No

AlphaStarInfinite

Set this parameter to damp the turbulent viscosity causing a low-Reynolds number correction.

Type Expression<double>

Read Only No

Betai1

Set constant used in dissipation of Omega.

Type Expression<double>

Read Only No

Betai2

Set constant used in dissipation of Omega.

Type Expression<double>

Read Only No

BetaStarInfinite

Set constant used in modeling the Turbulence Dissipation.

Type Expression<double>

Read Only No

Cmu

Set model constant.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 701
Study

Cs

Set Smagorinsky constant.

Type Expression<double>

Read Only No

Mt0

Set Compressibility Correction.

Type Expression<double>

Read Only No

TurbulenceEddyFrequencyPrandtlNumber1

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency
(omega) condition.

Type Expression<double>

Read Only No

TurbulenceEddyFrequencyPrandtlNumber2

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency
(omega) condition.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyPrandtlNumber1

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of
turbulence kinetic energy via turbulent transport.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyPrandtlNumber2

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of
turbulence kinetic energy via turbulent transport.

Type Expression<double>

Read Only No

ZetaStar

Set model constant used in the Turbulence Dissipation.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
702 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Expression<double>

Read Only No

Energy
Allows to choose between different energy initial condition.

Properties
Option

Allows to choose between different energy initial condition.

Type Option

Possible Values: Temperature

Read Only No

Temperature

Set temperature at wall.

Type Expression<Quantity>

Read Only No

Energy
Set boundary conditions related to Energy.

Properties
EntrainmentTemperature

Specify entrainment temperature for thermal analysis.

Type Expression<Quantity>

Read Only No

ExternalEmissivity

Set external emissivity.

Type Expression<Quantity>

Read Only No

ExternalHeatTransferCoefficient

Set heat transfer coefficient.

Type Expression<Quantity>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 703
Study

Read Only No

ExternalRadiationTemperature

Set external radiation temperature at wall.

Type Expression<Quantity>

Read Only No

ExternalTemperature

Set external temperature at wall.

Type Expression<Quantity>

Read Only No

HeatFlow

Set heat flow for thermal analysis.

Type Expression<Quantity>

Read Only No

HeatFlux

Set heat flux for thermal analysis.

Type Expression<Quantity>

Read Only No

HeatGenerationRate

Set heat generation rate.

Type Expression<Quantity>

Read Only No

Option

Set boundary conditions related to Energy.

Type Option

Possible Values: Convection

ConvectionAndRadiation
EntrainmentTemperature
HeatFlow
HeatFlux
Insulated
Radiation
StationaryFrameTotalEnthalpy

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
704 of ANSYS, Inc. and its subsidiaries and affiliates.
 Temperature
TotalEnthalpy
TotalTemperature

Read Only No

Temperature

Set temperature at wall.

Type Expression<Quantity>

Read Only No

TotalTemperature

Set total temperature.

Type Expression<Quantity>

Read Only No

EnergyControl
Configure solution advancement process for energy.

Properties
CourantNumber

Set the Courant number for current equation.

Type Expression<Quantity>

Read Only No

EnergyPseudoTransient

Applies pseudo transient under-relaxation method. The under-relaxation is controlled through pseudo
time step size.

Type EnergyPseudoTransient

Read Only No

ImplicitRelaxFactor

Set the value of under-relaxation factor for current equation.

Type Expression<Quantity>

Read Only No

Option

Allows to choose between relaxation factor, Courant number and pseudo-transient.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 705
Study

Type Option

Possible Values: CourantNumber

PseudoTransient
RelaxationFactor

Read Only No

EnergyInterfaceConditions
Set energy condition at interface.

Properties
EnergyInterfaceConditionForSide

Specify Energy conditions at each side of the interface.

Type IDictionary<string, Object>

Read Only No

EnergyInterfaceModel

Allows to choose between energy interface definitions.

Type EnergyInterfaceModel

Read Only No

EnergyInterfaceModel
Allows to choose between energy interface definitions.

Properties
HeatGenerationRate

Set heat generation rate.

Type Expression<Quantity>

Read Only No

MaterialName

Set the material.

Type Option

Possible Values: No options

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
706 of ANSYS, Inc. and its subsidiaries and affiliates.
Thickness

Set wall thickness.

Type Expression<Quantity>

Read Only No

EnergyModel
Configure Energy Model.

Properties
EnergyModelForPhase

Configure Energy Phase Model.

Type IDictionary<string, Object>

Read Only No

EnergyModelPhaseInteraction

Configure Energy Model for phase interaction.

Type IDictionary<string, Object>

Read Only No

Option

Configure Energy Model.

Type Option

Possible Values: Off

On
PhaseDependent

Read Only No

TurbulenceEnergyInteraction

Configure Energy Model for turbulence interaction.

Type TurbulenceEnergyInteraction

Read Only No

EnergyNearWallTreatment
Incorporate near wall treatment for energy interaction model.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 707
Study

Properties
PFunction

Allows to choose between different energy wall treatment definitions.

Type Option

Possible Values: Jayatilleke

LaunderSpalding

Read Only No

EnergyPeriodicityModel
Allows to choose between different energy periodicity models.

Properties
UpstreamBulkTemperature

Set the upstream bulk temperature value.

Type Expression<Quantity>

Read Only No

EnergyPseudoTransient
Applies pseudo transient under-relaxation method. The under-relaxation is controlled through pseudo
time step size.

Properties
LengthScaleCalculationMethod

Allows one to choose how the length scale is determined when using pseudo transient solution ad-
vancement.

Type LengthScaleCalculationMethod

Read Only No

Option

Allows one to select how the pseudo transient time scale is calculated for the energy equation.

Type Option

Possible Values: Automatic

Off
UserSpecified

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
708 of ANSYS, Inc. and its subsidiaries and affiliates.
PseudoTimestep

Set pseudo time step size.

Type Expression<Quantity>

Read Only No

RelativeScaleFactor

Set time scaling factor relative to the one specified for flow advancement

Type Expression<double>

Read Only No

TimestepScalingFactor

Set a scaling factor used to scale the calculated time step.

Type Expression<Quantity>

Read Only No

EnergyRadiatorConditions
Set radiator condition at the interface.

Properties
ExternalHeatTransferCoefficient

Set heat transfer coefficient.

Type Expression<Quantity>

Read Only No

ExternalTemperature

Set the external temperature.

Type Expression<Quantity>

Read Only No

HeatFlow

Set heat flow for thermal analysis.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 709
Study

HeatFlux

Set heat flux for thermal analysis.

Type Expression<Quantity>

Read Only No

ExternalBlackBodyTemperature
Configure External Black Body Temperature, which allows to take into account the influence of the
temperature of the gas and the walls beyond the inlet/exit boundaries.

Properties
BlackBodyTemperature

Set the black body temperature.

Type Expression<Quantity>

Read Only No

FASMultigridControls
Configure parameters related to the FAS multigrid solver (used only for Flow equations)

Properties
CorrectionReduction

Set the factor by which to reduce the magnitude of the multigrid corrections transferred from one level
to the next finer level.

Type Expression<double>

Read Only No

CorrectionSmoothing

Set the correction smoothing factor used to interpolate corrections from a coarser grid to a finer grid.

Type Expression<double>

Read Only No

CourantNumberReduction

Set the factor by which to reduce the Courant number for coarse grid levels.

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
710 of ANSYS, Inc. and its subsidiaries and affiliates.
MultigridLevels

Set maximum number of grid levels to be used in the multigrid process.

Type int

Read Only No

PostSweeps

Set the number of sweeps to perform after coarser level corrections have been applied.

Type int

Read Only No

PreSweeps

Set the number of iterations of the multi-stage solver to be performed on a given grid level before
proceeding to a coarser grid level.

Type int

Read Only No

FixedCycleControls
Configure parameters that control the V, W and F cycles.

Properties
CoarseningRate

Controls the number of equations on each successively coarser grid level. Number of equations on each
level will be 1/CoarseningRate of the number on the previous level.

Type int

Read Only No

CoupledFixedCycleSmoother

Choose smoother for coupled equations with fixed cycles.

Type Option

Possible Values: GaussSeidel

ILU

Read Only No

Factor

Set the value of factor.

Type Expression<Quantity>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 711
Study

Read Only No

MaximumCoarseLevels

Set the maximum number of coarse levels that will be built by multigrid solver.

Type int

Read Only No

MaximumCycles

Set the maximum number of V, W or F cycles to be performed.

Type int

Read Only No

PostSweeps

Set the number of sweeps to perform after coarser level corrections have been applied.

Type int

Read Only No

PreSweeps

Set the number of sweeps to perform before moving to a coarser level.

Type int

Read Only No

SymmetryWhenCoarsening

Enables symmetric coarsening.

Type bool

Read Only No

FixedCycleControls
Configure parameters that control the V, W and F cycles.

Properties
CoarseningRate

Controls the number of equations on each successively coarser grid level. Number of equations on each
level will be 1/CoarseningRate of the number on the previous level.

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
712 of ANSYS, Inc. and its subsidiaries and affiliates.
Factor

Set the value of factor.

Type Expression<Quantity>

Read Only No

MaximumCoarseLevels

Set the maximum number of coarse levels that will be built by multigrid solver.

Type int

Read Only No

MaximumCycles

Set the maximum number of V, W or F cycles to be performed.

Type int

Read Only No

PostSweeps

Set the number of sweeps to perform after coarser level corrections have been applied.

Type int

Read Only No

PreSweeps

Set the number of sweeps to perform before moving to a coarser level.

Type int

Read Only No

ScalarFixedCycleSmoother

Choose smoother for scalars with fixed cycles.

Type Option

Possible Values: GaussSeidel

ILU

Read Only No

SymmetryWhenCoarsening

Enables symmetric coarsening.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 713
Study

Read Only No

FlexibleCycleControls
Configure parameters that control the flexible multigrid cycle.

Properties
MaximumCoarseRelaxations

Set the maximum number of relaxations to be performed on each grid level above level 1 (coarse grid
levels).

Type int

Read Only No

MaximumCycles

Set the maximum number of V, W or F cycles to be performed.

Type int

Read Only No

MaximumFineRelaxations

Set the maximum number of relaxations to be performed on the level 1 grid (fine grid level).

Type int

Read Only No

Sweeps

Set the number of times to apply the smoothing method each time a relaxation is performed.

Type int

Read Only No

Flow
Configure the initial conditions.

Properties
GaugeStaticPressure

Set the gauge static pressure value.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
714 of ANSYS, Inc. and its subsidiaries and affiliates.
Option

Configure the initial conditions.

Type Option

Possible Values: StaticPressureAndVelocity

Read Only No

Velocity

Allows to specify the velocity direction in different coordinate system.

Type Velocity

Read Only No

Flow
Configure flow specification for the boundary.

Properties
AllowReverseFlow

Configure reverse flow for the boundary.

Type AllowReverseFlow

Read Only No

FlowDirection

Allows to specify the flow direction in different coordinate system.

Type FlowDirection

Read Only No

FullyDevelopedFlow

Configure the fully developed flow boundary condition.

Type FullyDevelopedFlow

Read Only No

MassFlow

Configure mass flow specifications for the boundary.

Type MassFlow

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 715
Study

Option

Select boundary specification option.

Type Option

Possible Values: Farfield

FreeSlip
FullyDevelopedFlow
MarangoniStress
MassFlow
NoSlip
Pressure
SpecifiedShear
SpecularityCoefficient
Velocity

Read Only No

Pressure

Configure pressure specifications for the boundary.

Type Pressure

Read Only No

ReferenceFrame

Select the parameters that define motion for a moving reference frame.

Type ReferenceFrame

Read Only No

Shear

Configure shear conditions at the wall.

Type Shear

Read Only No

SurfaceTensionGradient

Set the surface tension gradient value.

Type Expression<double>

Read Only No

Velocity

Configure velocity specifications for the boundary.

Type Velocity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
716 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

WallVelocity

Allows to choose between stationary or moving wall.

Type WallVelocity

Read Only No

FlowControl
Configure solution advancement process for momentum.

Properties
CourantNumber

Set the Courant number for current equation.

Type Expression<Quantity>

Read Only No

FlowPseudoTransient

Applies pseudo transient under-relaxation method. The under-relaxation is controlled through pseudo
time step size.

Type FlowPseudoTransient

Read Only No

ImplicitRelaxFactor

Set the value of under-relaxation factor for current equation.

Type Expression<Quantity>

Read Only No

Option

Allows to choose between relaxation factor, Courant number and pseudo-transient.

Type Option

Possible Values: CourantNumber

PseudoTransient
RelaxationFactor

Read Only No

FlowCoupling
Allows to choose solver formulations for density based solver.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 717
Study

Properties
FASMultigridControls

Configure parameters related to the FAS multigrid solver (used only for Flow equations)

Type FASMultigridControls

Read Only No

MultiStageControls

Configure parameters that govern the operation of the multi-stage solver.

Type MultiStageControls

Read Only No

Option

Allows to choose solver formulations for density based solver.

Type Option

Possible Values: Explicit

Implicit

Read Only No

ResidualSmoothening

Configure parameters that govern the use of implicit residual smoothing.

Type ResidualSmoothening

Read Only No

UseCASM

Enable convergence acceleration for stretched meshes to improve the convergence of the implicit
density based solver on meshes with high cell stretching.

Type bool

Read Only No

FlowDirection
Allows to specify the flow direction in different coordinate system.

Properties
AxialComponent

Set the axial component.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
718 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Expression<double>

Read Only No

CartesianDirectionComponents

Set the component in the different direction.

Type List<Expression<Quantity>>

Read Only No

CylindricalDirectionComponents

Set the component in the different direction.

Type List<Expression<Quantity>>

Read Only No

Option

Allows to specify the flow direction in different coordinate system.

Type Option

Possible Values: Cartesian

Cylindrical
CylindricalWithTangentialVelocity
NormalToBoundary

Read Only No

RadialComponent

Set the radial component.

Type Expression<double>

Read Only No

TangentialVelocity

Set the tangential component.

Type Expression<Quantity>

Read Only No

FlowInterfaceConditions
Configure flow interface.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 719
Study

Properties
CalculatePressureJumpFromAverageConditions

Enable to calculate pressure jump from average conditions.

Type bool

Read Only No

FacePermeability

Sets the face permeability coefficient value.

Type Expression<Quantity>

Read Only No

FlowInterfaceConditionForSide

Configure flow interaction condition for side.

Type IDictionary<string, Object>

Read Only No

InertialResistance

Set the inertial resistance value.

Type Expression<Quantity>

Read Only No

LimitPolynomialVelocityRange

Enables this will limit the minimum and maximum velocity magnitudes used to calculate the pressure
jump.

Type bool

Read Only No

LossCoefficient

Set loss coefficient value.

Type Expression<double>

Read Only No

MaximumVelocity

Set the maximum velocity values to which velocity magnitude is limited.

Type Expression<Quantity>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
720 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

MediumThickness

Set the thickness of porous medium.

Type Expression<Quantity>

Read Only No

MinimumVelocity

Set the minimum velocity values to which velocity magnitude is limited.

Type Expression<Quantity>

Read Only No

PressureJump

Set the pressure jump value.

Type Expression<Quantity>

Read Only No

ReverseFanDirection

Sets the reverse fan direction value.

Type List<Expression<Quantity>>

Read Only No

Swirl

Configure swirl in the model.

Type Swirl

Read Only No

FlowModel
Configure Flow Model.

Properties
FlowModelPhaseInteraction

Configure Flow Model with phase interaction.

Type IDictionary<string, Object>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 721
Study

OperatingConditions

Sets the parameters related to operating conditions in the model.

Type OperatingConditions

Read Only No

StressStrainModel

Configure Stress Strain Model.

Type StressStrainModel

Read Only No

FlowPeriodicityModel
Allows to choose between different flow periodicity models.

Properties
FlowDirection

Allows to specify the flow direction in different coordinate system.

Type FlowDirection

Read Only No

MassFlowRate

Set the mass flow rate value.

Type Expression<Quantity>

Read Only No

NumberOfIterations

Set the number of iterations.

Type int

Read Only No

PressureGradient

Set the pressure gradient value.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
722 of ANSYS, Inc. and its subsidiaries and affiliates.
RelaxationFactor

Set the value of relaxation factor.

Type Expression<double>

Read Only No

FlowPseudoTransient
Applies pseudo transient under-relaxation method. The under-relaxation is controlled through pseudo
time step size.

Properties
LengthScaleCalculationMethod

Allows one to choose how the length scale is determined when using pseudo transient solution ad-
vancement.

Type LengthScaleCalculationMethod

Read Only No

Option

Allows to choose 'Automatic' or manually specify the settings.

Type Option

Possible Values: Automatic

UserSpecified

Read Only No

PseudoTimestep

Set pseudo time step size.

Type Expression<Quantity>

Read Only No

TimestepScalingFactor

Set a scaling factor used to scale the calculated time step.

Type Expression<Quantity>

Read Only No

Verbosity

Set the verbosity. Enter a value of 1 to print pseudo time step size.

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 723
Study

Read Only No

FlowSolver
Configure flow solver.

Properties
Option

Allows to choose pressure or density based solver.

Type Option

Possible Values: DensityBased

PressureBased

Read Only No

FMGSettings
Configure FMG initialization settings

Properties
FMGCourantNumber

Specify Courant number for FMG initialization

Type Expression<Quantity>

Read Only No

FMGGridLevel

Configure each grid level for FMG initialization

Type IDictionary<string, Object>

Read Only No

NumberOfGridLevels

Set the number of multigrid levels for the FMG iteration.

Type int

Read Only No

FullyDevelopedFlow
Configure the fully developed flow boundary condition.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
724 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
FlowRateWeighting

Set the flow rate weighting factor (what portion of the outflow is through the boundary).

Type Expression<Quantity>

Read Only No

GeneralHybridSettings
Configure general hybrid setting in the model.

Properties
NumberOfIterations

Set the number of iterations.

Type int

Read Only No

TuneForExternalAero

Enable to better guess of the velocity field for external-aero problems.

Type bool

Read Only No

GlobalPosition
Configure the parameters to define the position of solar radiation.

Properties
Latitude

Set the latitude of the desired location in degrees.

Type Expression<Quantity>

Read Only No

Longitude

Set the longitude of the desired location in degrees.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 725
Study

TimeZone

Set the local time zone of the desired location in hours relative to GMT.

Type Expression<double>

Read Only No

HighOrderRhieChowScheme
Configure High Order Rhie Chow scheme

Properties
CurrentHighOrderRhieChowScheme

Shows active High Order Rhie Chow scheme

Type Option

Possible Values: FirstOrderMomentumWeighted

SecondOrderMomentumWeighted

Read Only No

HighOrderTermRelaxation
Configure relaxation of high order terms.

Properties
DefaultSetting

Enables to set the default value of relaxation factor.

Type Option

Possible Values: Off

On

Read Only No

Equation

Configure relaxation for high order terms for current equation.

Type IDictionary<string, Object>

Read Only No

Factor

Set the value of factor.

Type Expression<Quantity>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
726 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

ImbalanceConvergence
Configure imbalance convergence.

Properties
ImbalanceDefaultSetting

Configure imbalance default settings.

Type ImbalanceDefaultSetting

Read Only No

Option

Allows to choose default or equation based settings.

Type Option

Possible Values: DefaultSettings

EquationBasedSettings

Read Only No

ImbalanceDefaultSetting
Configure imbalance default settings.

Properties
ImbalanceTolerance

Set the value of imbalance tolerance.

Type Expression<double>

Read Only No

Option

Allows to set default value for convergence criteria of imbalance.

Type Option

Possible Values: None

SpecifyImbalanceTolerance

Read Only No

InitialConditions
Set the initial condition.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 727
Study

Properties
Acoustics

Set the acoustics initial conditions.

Type Acoustics

Read Only No

Energy

Allows to choose between different energy initial condition.

Type Energy

Read Only No

Flow

Configure the initial conditions.

Type Flow

Read Only No

GeneralHybridSettings

Configure general hybrid setting in the model.

Type GeneralHybridSettings

Read Only No

GridLevel

Configure grid level settings.

Type IDictionary<string, Object>

Read Only No

InitializationMethod

Select initialization method.

Type Option

Possible Values: Hybrid

UserSpecified

Read Only No

NumberOfGridLevels

Set the number of multigrid levels for the FMG iteration.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
728 of ANSYS, Inc. and its subsidiaries and affiliates.
Type int

Read Only No

Option

Allows to choose different initialization methods.

Type Option

Possible Values: FMG

Hybrid
UserSpecified

Read Only No

ReferenceFrameForInitialConditions

Set the reference frame for initial condition.

Type ReferenceFrameForInitialConditions

Read Only No

SpeciesHybridSettings

Configure hybrid initialization settings

Type SpeciesHybridSettings

Read Only No

Turbulence

Configure Turbulence initial conditions.

Type Turbulence

Read Only No

TurbulenceHybridSettings

Configure turbulence hybrid settings.

Type TurbulenceHybridSettings

Read Only No

UserScalarInitialConditions

to be documented

Type IDictionary<string, Object>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 729
Study

UserVectorInitialConditions

to be documented

Type IDictionary<string, Object>

Read Only No

InitialConditions
Set the initial condition.

Properties
Acoustics

Set the acoustics initial conditions.

Type Acoustics

Read Only No

Energy

Allows to choose between different energy initial condition.

Type Energy

Read Only No

Flow

Configure the initial conditions.

Type Flow

Read Only No

GeneralHybridSettings

Configure general hybrid setting in the model.

Type GeneralHybridSettings

Read Only No

GridLevel

Configure grid level settings.

Type IDictionary<string, Object>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
730 of ANSYS, Inc. and its subsidiaries and affiliates.
InitializationMethod

Select initialization method.

Type Option

Possible Values: Hybrid

UserSpecified

Read Only No

NumberOfGridLevels

Set the number of multigrid levels for the FMG iteration.

Type int

Read Only No

Option

Allows to choose different initialization methods.

Type Option

Possible Values: FMG

Hybrid
UserSpecified

Read Only No

ReferenceFrameForInitialConditions

Set the reference frame for initial condition.

Type ReferenceFrameForInitialConditions

Read Only No

SpeciesHybridSettings

Configure hybrid initialization settings

Type SpeciesHybridSettings

Read Only No

Turbulence

Configure Turbulence initial conditions.

Type Turbulence

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 731
Study

TurbulenceHybridSettings

Configure turbulence hybrid settings.

Type TurbulenceHybridSettings

Read Only No

UserScalarInitialConditions

to be documented

Type IDictionary<string, Object>

Read Only No

UserVectorInitialConditions

to be documented

Type IDictionary<string, Object>

Read Only No

InletBoundary
Set boundary.

Properties
BoundaryLocations

Set the boundary location.

Type List<string>

Read Only No

BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type BoundaryReferenceFrame

Read Only No

BoundaryType

Set different boundary type.

Type Option

Possible Values: Axis

Farfield
Inlet
Opening

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
732 of ANSYS, Inc. and its subsidiaries and affiliates.
 Outlet
Symmetry
Wall

Read Only No

Energy

Set boundary conditions related to Energy.

Type Energy

Read Only No

Flow

Configure flow specification for the boundary.

Type Flow

Read Only No

ParticleBoundaryConditions

to be documented

Type ParticleBoundaryConditions

Read Only No

Radiation

Configure radiation specifications for boundary.

Type Radiation

Read Only No

Regime

Configure flow regime.

Type Regime

Read Only No

Turbulence

Set turbulence related boundary conditions in the model.

Type Turbulence

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 733
Study

UserScalarBoundaryConditions

to be documented

Type IDictionary<string, Object>

Read Only No

UserVectorBoundaryConditions

to be documented

Type IDictionary<string, Object>

Read Only No

InterfaceModels
Allows to choose between different interface models.

Properties
RegionPair

Configure different interface conditions for region pair.

Type RegionPair

Read Only No

StreamwisePeriodicityModel

Allows to choose between different streamwise periodicity models.

Type StreamwisePeriodicityModel

Read Only No

InterfaceRegions
Set the physics region on either side of interface.

Properties
Side

Set the physics region and their topology ids on this side of interface.

Type IDictionary<string, Object>

Read Only No

IntersectionControl
configure to create matching or nonmatching interface.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
734 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
AngularTolerance

Set the angular tolerance.

Type Expression<Quantity>

Read Only No

MatchingInterface

Enable to choose matching interface.

Type bool

Read Only No

NormalToleranceFactor

Set the normal tolerance factor.

Type Expression<Quantity>

Read Only No

SmallestAreaToleranceFactor

Set the smallest area tolerance factor.

Type Expression<Quantity>

Read Only No

IterationControl
Configure settings for iteration control.

Properties
ConvergenceCriteria

Configure convergence criteria for residual, monitor, etc.

Type ConvergenceCriteria

Read Only No

EnergyIterationsPerRadiationIteration

Set the frequency with which the radiation terms are updated as the continuous phase solution proceeds.

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 735
Study

MaximumNumberOfIterations

Set the maximum number of iteration.

Type int

Read Only No

MaximumRadiationIterations

Set the maximum number of iterations of the radiation calculation during each global iteration.

Type int

Read Only No

MinimumNumberOfIterations

Set the minimum number of iterations.

Type int

Read Only No

ResidualConvergenceCriteria

Set the value to determine when the radiation intensity update is converged.

Type Expression<Quantity>

Read Only No

ke1eStandardModelConstants
Configure k-e 1e Standard model constants.

Properties
Aplus

Set model constant.

Type Expression<double>

Read Only No

C1

Set model constant.

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
736 of ANSYS, Inc. and its subsidiaries and affiliates.
C2

Set model constant.

Type Expression<double>

Read Only No

C3

Set model constant.

Type Expression<double>

Read Only No

Cs

Set Smagorinsky constant.

Type Expression<double>

Read Only No

PrandtlNumber

Set Prandtl number.

Type Expression<double>

Read Only No

kEpsilonRealizableModelConstants
Configure realizable K-Epsilon model constants.

Properties
C2Epsilon

Parameter used in the transport equation.

Type Expression<double>

Read Only No

TurbulenceDissipationRatePrandtlNumber

Set Effective Prandtl number for transport of the turbulent dissipation rate.

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 737
Study

TurbulenceKineticEnergyPrandtlNumber

Set Effective Prandtl number for transport of Turbulence Kinetic energy, which defines the ratio of the
momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.

Type Expression<double>

Read Only No

kEpsilonRNGModelConstants
Configure RNG K-Epsilon model constants.

Properties
C1Epsilon

Constant used in the transport equation for epsilon.

Type Expression<double>

Read Only No

C2Epsilon

Constant used in the transport equation for epsilon.

Type Expression<double>

Read Only No

Cmu

Constant used to compute.

Type Expression<Quantity>

Read Only No

kEpsilonStandardModelConstants
Configure standard k-Epsilon model constants.

Properties
C1Epsilon

Set constant in the equation of Standard k-epsilon turbulent flow.

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
738 of ANSYS, Inc. and its subsidiaries and affiliates.
C2Epsilon

Set constant in the equation of Standard k-epsilon turbulent flow.

Type Expression<double>

Read Only No

Cmu

Set k-Epsilon Standard Model Constant.

Type Expression<Quantity>

Read Only No

TurbulenceDissipationRatePrandtlNumber

Set Effective Prandtl number for transport of the turbulent dissipation rate.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyPrandtlNumber

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of
turbulence kinetic energy via turbulent transport.

Type Expression<double>

Read Only No

kOmegaBSLModelConstants
Configure kOmega Mean Base Line (BSL) Model Constants.

Properties
Betai1

Set Constant used in dissipation of Omega.

Type Expression<double>

Read Only No

Betai2

Set Constant used in dissipation of Omega.

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 739
Study

BetaStarInfinite

Constant used in modeling the Turbulence Dissipation.

Type Expression<double>

Read Only No

TurbulenceEddyFrequencyPrandtlNumber1

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency
(omega) condition.

Type Expression<double>

Read Only No

TurbulenceEddyFrequencyPrandtlNumber2

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency
(omega) condition.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyPrandtlNumber1

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of
turbulence kinetic energy via turbulent transport.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyPrandtlNumber2

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of
turbulence kinetic energy via turbulent transport.

Type Expression<double>

Read Only No

kOmegaSSTModelConstants
Configure K-Omega SST model constants.

Properties
A1

A1(alpha1)

Type Expression<double>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
740 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

Alpha0

Coefficient used in the Production of Omega.

Type Expression<double>

Read Only No

AlphaInfinite

Coefficient used in the Production of Omega.

Type Expression<double>

Read Only No

AlphaStarInfinite

Set to damp the turbulent viscosity causing a low-Reynolds number correction.

Type Expression<double>

Read Only No

BetaIInner

Constant used in the Turbulence Dissipation of omega for the SST k-omega Model.

Type Expression<double>

Read Only No

BetaIOuter

Constant used in the Turbulence Dissipation of omega for the SST k-omega Model.

Type Expression<double>

Read Only No

BetaStarInfinite

Constant used in modeling the Turbulence Dissipation of omega for the SST k-omega Model.

Type Expression<double>

Read Only No

Rbeta

Constant used in modeling the Turbulence Dissipation of omega for the SST k-omega Model.

Type Expression<double>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 741
Study

Read Only No

Rk

Constant used in the low Reynolds Number Correction.

Type Expression<double>

Read Only No

Romega

Constant used in the Production of Omega.

Type Expression<double>

Read Only No

TurbulenceEddyFrequencyInnerPrandtlNumber

Set Effective Prandtl number for the transport of the specific dissipation rate inside the near-wall region.

Type Expression<double>

Read Only No

TurbulenceEddyFrequencyOuterPrandtlNumber

Set Effective Prandtl number for the transport of the specific dissipation rate outside the near-wall region.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyInnerPrandtlNumber

Set Effective Prandtl number for the transport of turbulence kinetic energy inside the near-wall region.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyOuterPrandtlNumber

Set Effective Prandtl number for the transport of turbulence kinetic energy outside the near-wall region.

Type Expression<double>

Read Only No

kOmegaWilcoxModelConstants
Configure kOmega Wilcox model constants.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
742 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Alpha0

Set coefficient used in the Production of Omega.

Type Expression<double>

Read Only No

AlphaInfinite

Set coefficient used in the Production of Omega.

Type Expression<double>

Read Only No

AlphaStarInfinite

Set coefficient used in the Production of Omega.

Type Expression<double>

Read Only No

ANAT

Set model constant used in k-kl Omega Transition Model Transport Equations.

Type Expression<double>

Read Only No

Anu

Set model constant used in k-kl Omega Transition Model Transport Equations.

Type Expression<double>

Read Only No

ATS

Set model constant used in k-kl Omega Transition Model Transport Equations.

Type Expression<double>

Read Only No

Betai

Set constant used in modeling the Turbulence Dissipation.

Type Expression<double>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 743
Study

Read Only No

BetaStarInfinite

Set constant used in modeling the Turbulence Dissipation.

Type Expression<double>

Read Only No

CalphatEta

Set model constant used in k-kl Omega Transition Model Transport Equations.

Type Expression<double>

Read Only No

CINT

Set model constant used in k-kl Omega Transition Model Transport Equations.

Type Expression<double>

Read Only No

Clambda

Set constant used to define effective length.

Type Expression<double>

Read Only No

Cmu

Set model constant.

Type Expression<Quantity>

Read Only No

CNATcritical

Set model constant used in k-kl Omega Transition Model Transport Equations.

Type Expression<double>

Read Only No

CR

Set constant used in the definition of averaged effect of the breakdown of streamwise fluctuations into
turbulence during bypass transition.

Type Expression<double>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
744 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

CRNAT

Set model constant used in k-kl Omega Transition Model Transport Equations.

Type Expression<double>

Read Only No

Ctaul

Set model constant used in k-kl Omega Transition Model Transport Equations.

Type Expression<double>

Read Only No

CTScritical

Set model constant used in k-kl Omega Transition Model Transport Equations.

Type Expression<double>

Read Only No

CTurbulenceEddyFrequency1

Set model constant used in k-kl Omega Transition Model Transport Equations.

Type Expression<double>

Read Only No

CTurbulenceEddyFrequency3

Set model constant used in k-kl Omega Transition Model Transport Equations.

Type Expression<double>

Read Only No

Rbeta

Set constant used to generate Beta-i.

Type Expression<double>

Read Only No

Rk

Constant used in the low Reynolds Number Correction.

Type Expression<double>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 745
Study

Read Only No

Romega

Constant used in the Production of Omega.

Type Expression<double>

Read Only No

TransitionTurbulenceEddyFrequencyPrandtlNumber

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Transition Tubulent Eddy
Frequency condition.

Type Expression<double>

Read Only No

TransitionTurbulenceKineticEnergyPrandtlNumber

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Transition Tubulent Kin-
etic Energy condition.

Type Expression<double>

Read Only No

TurbulenceEddyFrequencyPrandtlNumber

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency
(omega) condition.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyPrandtlNumber

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of
turbulence kinetic energy via turbulent transport.

Type Expression<double>

Read Only No

LaunchControls
Defines how the fluids solver compute engine is configured.

Properties
NumberOfProcesses

Number of compute engine (solver) processes used to solve the simulation.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
746 of ANSYS, Inc. and its subsidiaries and affiliates.
Type int

Read Only No

SolverFilesDirectory

The location in which the fluids data files are stored.

Type string

Read Only Yes

LengthScaleCalculationMethod
Allows one to choose how the length scale is determined when using pseudo transient solution ad-
vancement.

Properties
LengthScale

Set the value of length scale. Useful in problems that have a specific length scale that is difficult to
determine from overall geometry such as airfoil.

Type Expression<Quantity>

Read Only No

Option

Allows to choose different length scale methods.

Type Option

Possible Values: Aggressive

Conservative
UserSpecified

Read Only No

LinearSolver
Configure generic setting related to advanced solution controls.

Properties
CoupledControls

Configure coupled controls.

Type CoupledControls

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 747
Study

FlexibleCycleControls

Configure parameters that control the flexible multigrid cycle.

Type FlexibleCycleControls

Read Only No

LinearSolverSettings

Configure linear solver settings for current equation.

Type IDictionary<string, Object>

Read Only No

ScalarControls

Configure scalar controls.

Type ScalarControls

Read Only No

Verbosity

Controls the amount of information that is printed out by the linear solver for monitoring purposes.

Type int

Read Only No

MassFlow
Configure mass flow specifications for the boundary.

Properties
AverageMassFlux

Set the mass flux value.

Type Expression<Quantity>

Read Only No

GaugeStaticPressure

Set the gauge static pressure value.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
748 of ANSYS, Inc. and its subsidiaries and affiliates.
MassFlowRate

Set the mass flow rate value.

Type Expression<Quantity>

Read Only No

MassFlowUpdate

Configure mass flow update options.

Type MassFlowUpdate

Read Only No

MassFlux

Set the mass flux value.

Type Expression<Quantity>

Read Only No

Option

Select option for mass flow specification.

Type Option

Possible Values: MassFlowRate

MassFlux

Read Only No

SpecifyAverageMassFlux

Enable to specify average mass flux through the zone.

Type bool

Read Only No

MassFlowUpdate
Configure mass flow update options.

Properties
GaugeStaticPressure

Set the gauge static pressure value.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 749
Study

GaugeStaticPressureAtMinimumRadius

Set the gauge static pressure value at minimum radial location.

Type Expression<Quantity>

Read Only No

LowerLimitOfAbsolutePressure

Specify the Lower Limit of Absolute Pressure.

Type Expression<Quantity>

Read Only No

NumberOfBands

Select reference frame for total pressure

Type NumberOfBands

Read Only No

Option

Select option for mass flow update.

Type Option

Possible Values: ScaleMassFlows

ShiftPressure
UniformFlux

Read Only No

PressureAveraging

Configure pressure averaging - allows the pressure along the outlet boundary to vary, but maintain an
average equivalent.

Type PressureAveraging

Read Only No

RadialEquilibrium

Enable the radial equilibrium pressure distribution.

Type bool

Read Only No

UpperLimitOfAbsolutePressure

Specify the Upper Limit of Absolute Pressure.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
750 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Expression<Quantity>

Read Only No

MeshOrientation
Configure the orientation as the vectors for North and East.

Properties
EastCoordinates

Specify the coordinate

Type List<Expression<Quantity>>

Read Only No

NorthCoordinates

Specify the coordinate

Type List<Expression<Quantity>>

Read Only No

Method
Select method for non-iterative time advancement

Properties
NeighborCorrection

Specify sub-iteration correction factor for non-iterative time advancement

Type int

Read Only No

ModelProperties
Configure input fields for material properties that are required for active physical models.

Properties
AbsorptionCoefficientModel

Configure parameters for absorption coefficient in radiation heat transfer.

Type AbsorptionCoefficientModel

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 751
Study

RefractiveIndexModel

Set refractive index for the material.

Type RefractiveIndexModel

Read Only No

MonitorConvergence
Set convergence criteria for monitors.

Properties
Option

Set convergence criteria for monitors.

Type Option

Possible Values: MonitorTolerance

None

Read Only No

MonitorFrequency
Configure Monitor Frequency.

Properties
IterationFrequency

Set the sampling frequency based on iteration.

Type int

Read Only No

Option

Allows to choose between different monitor frequency options.

Type Option

Possible Values: Iteration

None
SolutionTime
TimeStep

Read Only No

SolutionTimeFrequency

Set the Sampling frequency based on solution time.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
752 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Expression<Quantity>

Read Only No

TimeStepFrequency

Set the sampling frequency based on time step.

Type int

Read Only No

Monopole
Set the monopole characteristics

Properties
Amplitude

Set the amplitude value.

Type Expression<Quantity>

Read Only No

Frequency

Set the frequency value.

Type Expression<Quantity>

Read Only No

LocationCoordinates

Set the coordinates of reference pressure location.

Type List<Expression<double>>

Read Only No

RadiusFactor

Set the radius factor.

Type Expression<Quantity>

Read Only No

MorphologyModels
Allows to choose between phase definition models.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 753
Study

Properties
MultiphaseModels

Set the multiphase model type.

Type IDictionary<string, Object>

Read Only No

PhaseInteractions

Configure phase interactions.

Type PhaseInteractions

Read Only No

MovingWall
Configure moving wall in the model.

Properties
AngularSpeed

Sets the rotational speed of the wall.

Type Expression<Quantity>

Read Only No

Components

Allows to specify the velocity component in different coordinate system.

Type Components

Read Only No

Direction

Allows to choose between Cartesian or cylindrical component to specify direction.

Type Direction

Read Only No

Magnitude

Set the magnitude of the velocity.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
754 of ANSYS, Inc. and its subsidiaries and affiliates.
Option

Configure moving wall in the model.

Type Option

Possible Values: Components

MagnitudeAndDirection
Rotating

Read Only No

MultiStageControls
Configure parameters that govern the operation of the multi-stage solver.

Properties
NumberOfStages

Set the number of stages used in the multi-stage scheme.

Type int

Read Only No

Stage

Labels the stage to which the parameters apply.

Type IDictionary<string, Object>

Read Only No

NearWallTreatment
Configure the near-wall treatment to be used for modeling turbulence.

Properties
FullLowReNearWallDamping

Set this parameter to lower Reynolds Number near Wall Damping.

Type bool

Read Only No

Option

Allows to choose different methods for near wall treatment.

Type Option

Possible Values: LegacyFormulation

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 755
Study

NonEquilibriumWallFunction
ScalableWallFunction
StandardWallFunction
yPlusInsensitive
yPlusInsensitiveMenterLechner
yPlusInsensitiveTwoLayer

Read Only No

PressureGradientEffects

Enable/disable the pressure gradient effects on Model.

Type bool

Read Only No

Normalization
Allows one to choose to normalize residuals with respect to a residual at a particular iteration number.

Properties
Iteration

Set the number of iterations for which largest residual will be searched to normalize by.

Type int

Read Only No

Option

Allows whether or not to normalize residual for each variable.

Type Option

Possible Values: Automatic

None

Read Only No

NumberOfBands
Select reference frame for total pressure

Properties
MaximumNumber

Specifies the maximum number of bands to use for the radial pressure profile evaluation.

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
756 of ANSYS, Inc. and its subsidiaries and affiliates.
Option

Select total pressure reference frame among global and boundary frames.

Type Option

Possible Values: Automatic

SpecifiedMaximum

Read Only No

NumericalControls
Configure region wise numerics related controls.

Properties
DiscretizationControl

Configure conversion of scalar transport equations to discrete algebraic equations

Type DiscretizationControl

Read Only No

FlowSolver

Configure flow solver.

Type FlowSolver

Read Only No

SolutionControl

Configure common solution parameters.

Type SolutionControl

Read Only No

NumericalControls
Configure region wise numerics related controls.

Properties
DiscretizationControl

Configure conversion of scalar transport equations to discrete algebraic equations

Type DiscretizationControl

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 757
Study

FlowSolver

Configure flow solver.

Type FlowSolver

Read Only No

SolutionControl

Configure common solution parameters.

Type SolutionControl

Read Only No

OpeningBoundary
Set boundary.

Properties
BoundaryLocations

Set the boundary location.

Type List<string>

Read Only No

BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type BoundaryReferenceFrame

Read Only No

BoundaryType

Set different boundary type.

Type Option

Possible Values: Axis

Farfield
Inlet
Opening
Outlet
Symmetry
Wall

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
758 of ANSYS, Inc. and its subsidiaries and affiliates.
Energy

Set boundary conditions related to Energy.

Type Energy

Read Only No

Flow

Configure flow specification for the boundary.

Type Flow

Read Only No

ParticleBoundaryConditions

to be documented

Type ParticleBoundaryConditions

Read Only No

Radiation

Configure radiation specifications for boundary.

Type Radiation

Read Only No

Regime

Configure flow regime.

Type Regime

Read Only No

Turbulence

Set turbulence related boundary conditions in the model.

Type Turbulence

Read Only No

UserScalarBoundaryConditions

to be documented

Type IDictionary<string, Object>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 759
Study

UserVectorBoundaryConditions

to be documented

Type IDictionary<string, Object>

Read Only No

OperatingConditions
Sets the parameters related to operating conditions in the model.

Properties
GravitationalAcceleration

Set the gravitational acceleration value.

Type List<Expression<Quantity>>

Read Only No

OperatingPressure

Allows to choose between the fixed or floating operating pressure.

Type OperatingPressure

Read Only No

ReferencePressureLocation

Sets location for reference pressure for operating conditions.

Type ReferencePressureLocation

Read Only No

OperatingPressure
Allows to choose between the fixed or floating operating pressure.

Properties
Option

Allows to choose between the fixed or floating operating pressure.

Type Option

Possible Values: Fixed

Floating

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
760 of ANSYS, Inc. and its subsidiaries and affiliates.
Value

Sets the operating pressure value.

Type Expression<Quantity>

Read Only No

OutletBoundary
Set boundary.

Properties
BoundaryLocations

Set the boundary location.

Type List<string>

Read Only No

BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type BoundaryReferenceFrame

Read Only No

BoundaryType

Set different boundary type.

Type Option

Possible Values: Axis

Farfield
Inlet
Opening
Outlet
Symmetry
Wall

Read Only No

Energy

Set boundary conditions related to Energy.

Type Energy

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 761
Study

Flow

Configure flow specification for the boundary.

Type Flow

Read Only No

ParticleBoundaryConditions

to be documented

Type ParticleBoundaryConditions

Read Only No

Radiation

Configure radiation specifications for boundary.

Type Radiation

Read Only No

Regime

Configure flow regime.

Type Regime

Read Only No

Turbulence

Set turbulence related boundary conditions in the model.

Type Turbulence

Read Only No

UserScalarBoundaryConditions

to be documented

Type IDictionary<string, Object>

Read Only No

UserVectorBoundaryConditions

to be documented

Type IDictionary<string, Object>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
762 of ANSYS, Inc. and its subsidiaries and affiliates.
Parameters
Configure settings related to the hemicube and ray tracing methods for computing the view factors.

Properties
NormalizedSeparationDistance

Set ratio of the minimum face separation to the effective diameter of the face.

Type Expression<Quantity>

Read Only No

Resolution

Set resolution of the hemicube.

Type int

Read Only No

Subdivisions

Set number of subfaces into which each face is divided.

Type int

Read Only No

ParticleBoundaryConditions
to be documented

Properties
ParticleEnergyBoundaryConditions

to be documented

Type ParticleEnergyBoundaryConditions

Read Only No

ParticleFlowBoundaryConditions

to be documented

Type ParticleFlowBoundaryConditions

Read Only No

ParticleEnergyBoundaryConditions
to be documented

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 763
Study

Properties
ParticleEnergyBoundaryCondition

to be documented

Type IDictionary<string, Object>

Read Only No

ParticleFlowBoundaryConditions
to be documented

Properties
ParticleFlowBoundaryCondition

to be documented

Type IDictionary<string, Object>

Read Only No

PeriodicityType
Choose periodicity type.

Properties
RotationAngle

Allows to choose rotation angle between automatic and user specified.

Type RotationAngle

Read Only No

TranslationVector

Set the translational offset of periodic interface.

Type TranslationVector

Read Only No

PhaseDefinition
Create phase definition.

Properties
MaterialName

Set the material.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
764 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Option

Possible Values: No options

Read Only No

PhaseInteractions
Configure phase interactions.

Properties
PhaseInteraction

Configure phase interactions between different phases.

Type IDictionary<string, Object>

Read Only No

PhaseModels
Set the physics models.

Properties
EnergyModel

Configure Energy Model.

Type EnergyModel

Read Only No

FlowModel

Configure Flow Model.

Type FlowModel

Read Only No

MorphologyModels

Allows to choose between phase definition models.

Type MorphologyModels

Read Only No

RadiationModel

Configure Radiation Model.

Type RadiationModel

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 765
Study

Read Only No

TurbulenceModel

Configure Turbulence Model.

Type TurbulenceModel

Read Only No

UserScalarModel

to be documented

Type IDictionary<string, Object>

Read Only No

UserVectorModel

to be documented

Type IDictionary<string, Object>

Read Only No

PhaseModels
Set the physics models.

Properties
EnergyModel

Configure Energy Model.

Type EnergyModel

Read Only No

FlowModel

Configure Flow Model.

Type FlowModel

Read Only No

MorphologyModels

Allows to choose between phase definition models.

Type MorphologyModels

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
766 of ANSYS, Inc. and its subsidiaries and affiliates.
RadiationModel

Configure Radiation Model.

Type RadiationModel

Read Only No

TurbulenceModel

Configure Turbulence Model.

Type TurbulenceModel

Read Only No

UserScalarModel

to be documented

Type IDictionary<string, Object>

Read Only No

UserVectorModel

to be documented

Type IDictionary<string, Object>

Read Only No

PhysicsRegion
Set the areas within the geometry that you want to assign physical properties.

Properties
PhysicsRegionLocation

Set the topology locations of the physics region.

Type List<string>

Read Only No

PhysicsType

Set the physics type.

Type PhysicsType

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 767
Study

PhysicsRegionInterface
Set the physics region on interface.

Properties
ConnectionType

Choose connection type for interface.

Type ConnectionType

Read Only No

InterfaceModels

Allows to choose between different interface models.

Type InterfaceModels

Read Only No

InterfaceRegions

Set the physics region on either side of interface.

Type InterfaceRegions

Read Only No

IntersectionControl

configure to create matching or nonmatching interface.

Type IntersectionControl

Read Only No

NonOverlapConditions

Configure boundary conditions for non overlapped part of interface.

Type IDictionary<string, Object>

Read Only No

ReferenceFrameForRegionInterface

Choose reference frame for region interface

Type ReferenceFrameForRegionInterface

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
768 of ANSYS, Inc. and its subsidiaries and affiliates.
PhysicsRegionInterface
Set the physics region on interface.

Properties
ConnectionType

Choose connection type for interface.

Type ConnectionType

Read Only No

InterfaceModels

Allows to choose between different interface models.

Type InterfaceModels

Read Only No

InterfaceRegions

Set the physics region on either side of interface.

Type InterfaceRegions

Read Only No

IntersectionControl

configure to create matching or nonmatching interface.

Type IntersectionControl

Read Only No

NonOverlapConditions

Configure boundary conditions for non overlapped part of interface.

Type IDictionary<string, Object>

Read Only No

ReferenceFrameForRegionInterface

Choose reference frame for region interface

Type ReferenceFrameForRegionInterface

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 769
Study

PhysicsType
Set the physics type.

Properties
PhysicsTypeList

Set the physics type of the region (String list can have Fluid or Thermal or both).

Type List<string>

Read Only No

PorousResistanceModel
Configure Porous Resistance Model.

Properties
C0

Set the user-defined empirical coefficient value for C0.

Type Expression<double>

Read Only No

C1

Set the user-defined empirical coefficient value for C1.

Type Expression<Quantity>

Read Only No

InertialResistanceCoefficient

Set the inertial resistance coefficient value.

Type Expression<Quantity>

Read Only No

InertialResistanceComponents

Set the inertial resistance components Value.

Type List<Expression<Quantity>>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
770 of ANSYS, Inc. and its subsidiaries and affiliates.
InertialResistanceFormulation

Allows to choose between standard and alternative inertial formulation, this is preferred when porous
media contains highly anisotropic inertial resistance.

Type Option

Possible Values: Alternative

Standard

Read Only No

StreamwiseDirection

Sets the streamwise direction.

Type List<Expression<Quantity>>

Read Only No

StreamwiseInertialResistanceCoefficient

Set the streamwise inertial resistance coefficient value.

Type Expression<Quantity>

Read Only No

StreamwiseViscousResistanceCoefficient

Set the streamwise viscous resistance coefficient value.

Type Expression<Quantity>

Read Only No

TransverseInertialResistanceCoefficient

Set the transverse resistance coefficient value.

Type Expression<Quantity>

Read Only No

TransverseViscousResistanceCoefficient

Set the transverse viscous resistance coefficient value.

Type Expression<Quantity>

Read Only No

VelocityResistanceFormulation

Allows to choose between absolute (fluid in the domain is not moving) or relative (fluid in the domain
is moving) formulation.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 771
Study

Type Option

Possible Values: Absolute

Relative

Read Only No

ViscousResistanceCoefficient

Set the transverse inertial resistance coefficient value.

Type Expression<Quantity>

Read Only No

ViscousResistanceComponents

Set the viscous resistance components value.

Type List<Expression<Quantity>>

Read Only No

Pressure
Configure pressure specifications for the boundary.

Properties
GaugeEntrainmentPressure

Set the gauge entrainment pressure value.

Type Expression<Quantity>

Read Only No

GaugeStaticPressure

Set the gauge static pressure value.

Type Expression<Quantity>

Read Only No

GaugeStaticPressureAtMinimumRadius

Set the gauge static pressure value at minimum radial location.

Type Expression<Quantity>

Read Only No

GaugeTotalPressure

Sets the gauge total (or stagnation) pressure of the inflow stream.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
772 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Expression<Quantity>

Read Only No

NumberOfBands

Select reference frame for total pressure

Type NumberOfBands

Read Only No

PressureAveraging

Configure pressure averaging - allows the pressure along the outlet boundary to vary, but maintain an
average equivalent.

Type PressureAveraging

Read Only No

PressureOption

Select pressure specification option.

Type Option

Possible Values: EntrainmentPressure

TotalPressure

Read Only No

RadialEquilibrium

Enable the radial equilibrium pressure distribution.

Type bool

Read Only No

TotalPressureFrame

Select reference frame for total pressure

Type TotalPressureFrame

Read Only No

PressureAveraging
Configure pressure averaging - allows the pressure along the outlet boundary to vary, but maintain an
average equivalent.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 773
Study

Properties
Option

Select option for pressure averaging.

Type Option

Possible Values: Average

None
WeakAverage

Read Only No

PressureProfileBlend

Factor that blends between the specified pressure profile and a floating pressure profile. For a Pressure
Profile Blend factor of zero the specified pressure is used only to enforce the average pressure.

Type Expression<double>

Read Only No

PressureScheme
Select how pressure is interpolated from cells to faces

Properties
CurrentPressureScheme

See active pressure scheme

Type Option

Possible Values: BodyForceWeighted

FirstOrder
Linear
PRESTO
SecondOrder

Read Only No

Option

Allows to choose between different pressure interpolation schemes.

Type Option

Possible Values: Automatic

BodyForceWeighted
Expert
FirstOrder
Hybrid
Linear

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
774 of ANSYS, Inc. and its subsidiaries and affiliates.
 PRESTO
SecondOrder

Read Only No

PRESTOScheme

Refine PRESTO scheme by selecting among Standard, Unstructured and Low Order

Type Option

Possible Values: LowOrder

Standard
Unstructured

Read Only No

PressureVelocityCoupling
Allows to choose different schemes for pressure-velocity coupling.

Properties
NeighborCorrection

Specify sub-iteration correction factor for non-iterative time advancement

Type int

Read Only No

Option

Allows to choose different schemes for pressure-velocity coupling.

Type Option

Possible Values: Coupled

PISO
SIMPLE
SIMPLEC

Read Only No

SkewnessCorrection

Enables the SIMPLEC and PISO skewness correction for highly skewed meshes, if the value (number of
iterations) is greater than 0.

Type int

Read Only No

SkewnessNeighborCoupling

Enables the PISO neighbor correction, which is recommended for transient calculations.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 775
Study

Type bool

Read Only No

ProductionLimiter
Configure to limit the production term in the turbulence equation.

Properties
CPkLim

Coefficient used by the Production Limiter.

Type Expression<double>

Read Only No

LimiterOption

Enable to limit the production term in the turbulence equation.

Type Option

Possible Values: Off

On

Read Only No

ProductionSettings
Configure the parameter and constant for production setting.

Properties
CDokMu

Set Model constant

Type Expression<double>

Read Only No

CompressibleProduction

Choose to set compressible production in the model.

Type Option

Possible Values: Off

On

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
776 of ANSYS, Inc. and its subsidiaries and affiliates.
CPkMu

Set Model constant

Type Expression<double>

Read Only No

Production

Choose from options to limit the production term in the turbulence equation.

Type Option

Possible Values: KatoLaunder

Standard

Read Only No

ProductionLimiter

Configure to limit the production term in the turbulence equation.

Type ProductionLimiter

Read Only No

Radiation
Configure radiation specifications for boundary.

Properties
ApplyDirectIrradiationParallelToBeam

When enabled, assumes the value of direct irradiation specify is parallel to beam direction.

Type bool

Read Only No

BeamDirection

Configure radiation beam direction.

Type BeamDirection

Read Only No

BeamWidth

Set beam width for an external semi-transparent wall in terms of the Theta and Phi extents.

Type BeamWidth

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 777
Study

CriticalZone

Enable/Disable that wall is a critical zone.

Type bool

Read Only No

DiffuseFraction

Specify the fraction of the irradiation that is to be treated as diffuse.

Type IDictionary<string, Object>

Read Only No

DiffuseIrradiation

Specify the value of the irradiation flux.

Type IDictionary<string, Object>

Read Only No

DirectIrradiation

Specify the value of the irradiation flux.

Type IDictionary<string, Object>

Read Only No

ExternalBlackBodyTemperature

Configure External Black Body Temperature, which allows to take into account the influence of the
temperature of the gas and the walls beyond the inlet/exit boundaries.

Type ExternalBlackBodyTemperature

Read Only No

FacesPerSurfaceCluster

sets the number of faces per surface cluster for the wall.

Type int

Read Only No

InternalEmissivity

Specify the internal emissivity of the wall in each wavelength band.

Type IDictionary<string, Object>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
778 of ANSYS, Inc. and its subsidiaries and affiliates.
ParticipatesInViewFactorCalculation

Enable/Disable whether wall participates in the view factor calculation.

Type bool

Read Only No

TransparencyOption

Specify transparency option.

Type Option

Possible Values: Opaque

SemiTransparent

Read Only No

RadiationInterfaceConditions
Configure parameters for Radiation Interface Conditions.

Properties
InterfaceTransparencyOption

Choose Interface Transparency Option.

Type Option

Possible Values: Opaque

SemiTransparent

Read Only No

RadiationInterfaceConditionForSide

Specify Radiation Interface condition for side.

Type IDictionary<string, Object>

Read Only No

RadiationModel
Configure Radiation Model.

Properties
AngularDiscretization

Configure parameters for angular discretization and pixelation for the DO mode.

Type AngularDiscretization

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 779
Study

Read Only No

DOEnergyCoupling

Set Couples energy and DO (Discrete Ordinates) intensity equations at each cell.

Type bool

Read Only No

ModelProperties

Configure input fields for material properties that are required for active physical models.

Type ModelProperties

Read Only No

Option

Allows to choose between different radiation models.

Type Option

Possible Values: DiscreteOrdinates

Off
P1
SurfaceToSurface

Read Only No

SpectralModel

Configure supported Spectral models.

Type SpectralModel

Read Only No

ViewFactorsAndClustering

Configure parameters for surface clusters and view factors calculation.

Type ViewFactorsAndClustering

Read Only No

RANSModel
Configure options for specifying the viscous model.

Properties
BoundaryLayerTransitionModel

Choose options for Boundary Layer Transition model.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
780 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Option

Possible Values: Intermittency

IntermittencyReTheta
None
WaltersKKLOmega

Read Only No

BuoyancyEffects

Include the buoyancy effects on Model.

Type Option

Possible Values: Full

Off
ProductionOnly

Read Only No

CompressibilityEffects

Enable/disable Compressibility effects.

Type bool

Read Only No

CorrectionCoefficient

Set Correction Coefficient for the DES Model.

Type Expression<Quantity>

Read Only No

CurvatureCorrection

When enabled, modifies the turbulence production term to sensitize the standard eddy-viscosity models
to the effects of streamline curvature and system rotation.

Type Option

Possible Values: Off

On

Read Only No

DesModel

Specifies turbulent flow to be calculated using the Detached Eddy Simulation model.

Type DesModel

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 781
Study

EARSMRgKEpsilonModelConstants

Configure K-Epsilon model constants.

Type EARSMRgKEpsilonModelConstants

Read Only No

EARSMRgKOmegaBSLModelConstants

Configure KOmega BSL model constants.

Type EARSMRgKOmegaBSLModelConstants

Read Only No

EARSMRgKOmegaModelConstants

Configure Rumsey Gatski KOmega model constants.

Type EARSMRgKOmegaModelConstants

Read Only No

EARSMWjKOmegaBSLModelConstants

Configure KOmega BSL model constants.

Type EARSMWjKOmegaBSLModelConstants

Read Only No

ke1eStandardModelConstants

Configure k-e 1e Standard model constants.

Type ke1eStandardModelConstants

Read Only No

kEpsilonRealizableModelConstants

Configure realizable K-Epsilon model constants.

Type kEpsilonRealizableModelConstants

Read Only No

kEpsilonRNGModelConstants

Configure RNG K-Epsilon model constants.

Type kEpsilonRNGModelConstants

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
782 of ANSYS, Inc. and its subsidiaries and affiliates.
kEpsilonStandardModelConstants

Configure standard k-Epsilon model constants.

Type kEpsilonStandardModelConstants

Read Only No

kOmegaBSLModelConstants

Configure kOmega Mean Base Line (BSL) Model Constants.

Type kOmegaBSLModelConstants

Read Only No

kOmegaSSTModelConstants

Configure K-Omega SST model constants.

Type kOmegaSSTModelConstants

Read Only No

kOmegaWilcoxModelConstants

Configure kOmega Wilcox model constants.

Type kOmegaWilcoxModelConstants

Read Only No

LowReCorrections

Specifies whether corrections that improve the accuracy in predicting low Reynolds number flows should
be included.

Type bool

Read Only No

NearWallTreatment

Configure the near-wall treatment to be used for modeling turbulence.

Type NearWallTreatment

Read Only No

Option

Allows to choose between different RANS models.

Type Option

Possible Values: EARSMRumseyGatskiKEpsilon

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 783
Study

EARSMRumseyGatskiKOmega
EARSMRumseyGatskiKOmegaBSL
EARSMWallinJohanssonKOmegaBSL
RSMEpsilon
RSMOmega
SpalartAllmaras
kEpsilonRNG
kEpsilonRealizable
kEpsilonStandard
kOmegaBSL
kOmegaSST
kOmegaWilcox
ke1eStandard

Read Only No

ProductionSettings

Configure the parameter and constant for production setting.

Type ProductionSettings

Read Only No

RSMEpsilonModelConstants

Configure Reynolds Stress Model-Epsilon constants.

Type RSMEpsilonModelConstants

Read Only No

RSMOmegaModelConstants

Configure model constants in Omega Reynolds Stress Model.

Type RSMOmegaModelConstants

Read Only No

ShearFlowCorrections

Specifies whether corrections that improve the accuracy in predicting free shear flows should be included.

Type bool

Read Only No

SpalartAllmarasModelConstants

Configure parameters for the turbulent flow to be calculated using the Spalart-Allmaras model.

Type SpalartAllmarasModelConstants

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
784 of ANSYS, Inc. and its subsidiaries and affiliates.
SpalartAllmarasProduction

Choose from the options whether the flow is vorticity based or Strain Vorticity based in Spalart-Allmaras
model.

Type Option

Possible Values: StrainVorticityBased

VorticityBased

Read Only No

TurbulenceModelSuppression

Choose from the options to block either Turbulence Production or Turbulence Viscosity Production or
None in DES Model.

Type Option

Possible Values: NoTurbulenceProduction

NoTurbulenceViscosityAndProduction
None

Read Only No

ReferenceFrame
Select the parameters that define motion for a moving reference frame.

Properties
Option

Specify whether the reference frame for the boundary is absolute or relative to physics region.

Type Option

Possible Values: Absolute

RelativeToPhysicsRegion

Read Only No

ReferenceFrameForInitialConditions
Set the reference frame for initial condition.

Properties
FrameName

Select a frame from the defined reference frames.

Type DataObject

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 785
Study

Option

Set the reference frame for initial condition.

Type Option

Possible Values: SpecifyFrame

UseFromPhysicsRegion

Read Only No

ReferenceFrameForRegionInterface
Choose reference frame for region interface

Properties
AdjacentPhysicsRegion

Set the physics region of which reference frame to used.

Type Option

Possible Values: No options

Read Only No

FrameName

Select a frame from the defined reference frames.

Type DataObject

Read Only No

ReferencePressureLocation
Sets location for reference pressure for operating conditions.

Properties
Coordinates

Sets the coordinates value of reference pressure location.

Type List<Expression<Quantity>>

Read Only No

Option

Allows one to select where in your simulation the reference pressure is set.

Type Option

Possible Values: Automatic

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
786 of ANSYS, Inc. and its subsidiaries and affiliates.
 CartesianCoordinates

Read Only No

RefractiveIndexModel
Set refractive index for the material.

Properties
MaterialRefractiveIndex

Specify refractive index for the material.

Type IDictionary<string, Object>

Read Only No

Regime
Configure flow regime.

Properties
Option

Select regime among mixed, subsonic and supersonic.

Type Option

Possible Values: Mixed

Subsonic
Supersonic

Read Only No

RegionPair
Configure different interface conditions for region pair.

Properties
EnergyInterfaceConditions

Set energy condition at interface.

Type EnergyInterfaceConditions

Read Only No

EnergyRadiatorConditions

Set radiator condition at the interface.

Type EnergyRadiatorConditions

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 787
Study

Read Only No

FlowInterfaceConditions

Configure flow interface.

Type FlowInterfaceConditions

Read Only No

RadiationInterfaceConditions

Configure parameters for Radiation Interface Conditions.

Type RadiationInterfaceConditions

Read Only No

ResidualControl
Configure settings to control residual information.

Properties
MonitorFrequency

Configure Monitor Frequency.

Type MonitorFrequency

Read Only No

Normalization

Allows one to choose to normalize residuals with respect to a residual at a particular iteration number.

Type Normalization

Read Only No

ResidualScaling

Allows one to choose how control volume equation residuals are scaled so that they are dimensionless.

Type ResidualScaling

Read Only No

ResidualConvergence
Configure convergence criteria for residuals.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
788 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
ResidualDefaultSetting

Set default value of convergence criteria for residual.

Type ResidualDefaultSetting

Read Only No

ResidualTolerance

Set convergence criteria for current equation.

Type IDictionary<string, Object>

Read Only No

ResidualDefaultSetting
Set default value of convergence criteria for residual.

Properties
Option

Set default value of convergence criteria for residual.

Type Option

Possible Values: None

Tolerance

Read Only No

Value

Set the default tolerance value.

Type Expression<double>

Read Only No

ResidualScaling
Allows one to choose how control volume equation residuals are scaled so that they are dimensionless.

Properties
LocalScalingOption

Allows to choose different options for local scaling of residuals.

Type Option

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 789
Study

Possible Values: Maximum

RMS

Read Only No

Option

Allows one to choose different options for residuals scaling.

Type Option

Possible Values: GlobalScaling

LocalScaling
None

Read Only No

ResidualSmoothening
Configure parameters that govern the use of implicit residual smoothing.

Properties
Iterations

Set the number of iterations of the Jacobi smoother to use. If Iterations is 0, then no implicit residual
smoothing is performed.

Type int

Read Only No

SmoothingFactor

Set the implicit residual smoothing factor. This item will not appear unless Iterations is set to a non-
zero value.

Type Expression<double>

Read Only No

ReynoldsStresses
Configure Reynolds stress model.

Properties
Option

Set turbulent flow to be calculated using the RSM.

Type Option

Possible Values: Isotropic

RSMComponents

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
790 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

UU

Specify Reynolds stress components.

Type Expression<Quantity>

Read Only No

UV

Specify Reynolds stress components.

Type Expression<Quantity>

Read Only No

UW

Specify Reynolds stress components.

Type Expression<Quantity>

Read Only No

VV

Specify Reynolds stress components.

Type Expression<Quantity>

Read Only No

VW

Specify Reynolds stress components.

Type Expression<Quantity>

Read Only No

WW

Specify Reynolds stress components.

Type Expression<Quantity>

Read Only No

RotationAngle
Allows to choose rotation angle between automatic and user specified.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 791
Study

Properties
SpecifiedRotationAngle

set the rotational offset of periodic interface.

Type Expression<Quantity>

Read Only No

RSMEpsilonModelConstants
Configure Reynolds Stress Model-Epsilon constants.

Properties
C1Epsilon

Set constant used in the transport equation for Epsilon.

Type Expression<double>

Read Only No

C1primePS

Set model constant.

Type Expression<double>

Read Only No

C1primeSSGPS

Set model constant.

Type Expression<double>

Read Only No

C1PS

Set model constant.

Type Expression<double>

Read Only No

C1SSGPS

Set model constant.

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
792 of ANSYS, Inc. and its subsidiaries and affiliates.
C2EpsilonLinear

Set constant used in the transport equation for Epsilon.

Type Expression<double>

Read Only No

C2EpsilonQuadratic

Set constant used in the transport equation for Epsilon.

Type Expression<double>

Read Only No

C2primePS

Set model constant.

Type Expression<double>

Read Only No

C2PS

Set model constant.

Type Expression<double>

Read Only No

C2SSGPS

Set model constant.

Type Expression<double>

Read Only No

C3primeSSGPS

Set model constant.

Type Expression<double>

Read Only No

C3SSGPS

Set model constant.

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 793
Study

C4SSGPS

Set model constant.

Type Expression<double>

Read Only No

C5SSGPS

Set model constant.

Type Expression<double>

Read Only No

Cmu

Set model constant.

Type Expression<Quantity>

Read Only No

TurbulenceDissipationRatePrandtlNumber

Set Effective Prandtl number for transport of the turbulent dissipation rate.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyPrandtlNumber

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of
turbulence kinetic energy via turbulent transport.

Type Expression<double>

Read Only No

RSMOmegaModelConstants
Configure model constants in Omega Reynolds Stress Model.

Properties
Alpha0

Set coefficient used in the Production of Omega.

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
794 of ANSYS, Inc. and its subsidiaries and affiliates.
AlphaInfinite

Set coefficient used in the Production of Omega.

Type Expression<double>

Read Only No

AlphaStarInfinite

Set coefficient used in the Production of Omega.

Type Expression<double>

Read Only No

Betai

Set constant used in modeling the Turbulence Dissipation.

Type Expression<double>

Read Only No

BetaStarInfinite

Set constant used in modeling the Turbulence Dissipation.

Type Expression<double>

Read Only No

C1PS

Set model constant.

Type Expression<double>

Read Only No

C2PS

Set model constant.

Type Expression<double>

Read Only No

Cs

Set model constant.

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 795
Study

Mt0

Compressibility Correction.

Type Expression<double>

Read Only No

Rbeta

Set constant used in modeling the Turbulence Dissipation.

Type Expression<double>

Read Only No

Rk

Set constant used in the low Reynolds Number Correction.

Type Expression<double>

Read Only No

Romega

Set constant used in the Production of Omega.

Type Expression<double>

Read Only No

TurbulenceEddyFrequencyPrandtlNumber

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency
(omega) condition.

Type Expression<double>

Read Only No

TurbulenceKineticEnergyPrandtlNumber

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of
turbulence kinetic energy via turbulent transport.

Type Expression<double>

Read Only No

ZetaStar

Set model constant used in the Turbulence Dissipation.

Type Expression<double>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
796 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

ScalarControls
Configure scalar controls.

Properties
FixedCycleControls

Configure parameters that control the V, W and F cycles.

Type FixedCycleControls

Read Only No

Shear
Configure shear conditions at the wall.

Properties
Option

Configure shear conditions at the wall

Type Option

Possible Values: Cartesian

Cylindrical

Read Only No

ShearStress

Set the Pressure Components value.

Type List<Expression<Quantity>>

Read Only No

SimulationTermination
Configure settings for simulation termination.

Properties
EndTime

Set the ending time for the calculation.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 797
Study

Value

Set the number of time steps to be performed.

Type int

Read Only No

SolarCalculator
Configure parameters related to the calculation of solar load models.

Properties
DateAndTime

Configure parameters to specify date and time.

Type DateAndTime

Read Only No

GlobalPosition

Configure the parameters to define the position of solar radiation.

Type GlobalPosition

Read Only No

MeshOrientation

Configure the orientation as the vectors for North and East.

Type MeshOrientation

Read Only No

SolarIrradiationMethod

Choose parameters of the solar irradiation method

Type Option

Possible Values: FairWeatherConditions

TheoreticalMaximum

Read Only No

SunshineFactor

Set Sunshine Factor, which is linear reduction factor for the computed incident load that allows for
cloud cover to be accounted

Type Expression<Quantity>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
798 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

SolutionControl
Configure common solution parameters.

Properties
AdvancementControl

Configure advance control setting for solver.

Type AdvancementControl

Read Only No

CouplingControl

Configure settings for solution advancement.

Type CouplingControl

Read Only No

ExplicitRelaxation

Allows to set the value of under-relaxation factors.

Type IDictionary<string, Object>

Read Only No

HighOrderTermRelaxation

Configure relaxation of high order terms.

Type HighOrderTermRelaxation

Read Only No

LinearSolver

Configure generic setting related to advanced solution controls.

Type LinearSolver

Read Only No

SolutionLimits

Configure bounds for solution fields

Type SolutionLimits

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 799
Study

SolutionSteering

Fine-tune or override solver settings elsewhere using solution steerings.

Type SolutionSteering

Read Only No

SolutionControls
Configure generic settings for solution controls.

Properties
CalculationControl

Configure calculation specific settings.

Type CalculationControl

Read Only No

ParticleControl

to be documented

Type IDictionary<string, Object>

Read Only No

SolvePrimaryLinearSystem

Turn On to solve primary linear system.

Type bool

Read Only No

WithRespectTo

Set independent variable.

Type string

Read Only No

SolutionControls
Configure generic settings for solution controls.

Properties
CalculationControl

Configure calculation specific settings.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
800 of ANSYS, Inc. and its subsidiaries and affiliates.
Type CalculationControl

Read Only No

ParticleControl

to be documented

Type IDictionary<string, Object>

Read Only No

SolvePrimaryLinearSystem

Turn On to solve primary linear system.

Type bool

Read Only No

WithRespectTo

Set independent variable.

Type string

Read Only No

SolutionLimits
Configure bounds for solution fields

Properties
AbsolutePressurePositivityRate

Specify positivity rate for rate of reduction of temperature

Type Expression<Quantity>

Read Only No

MaximumAbsolutePressure

Specify upper bound for absolute pressure

Type Expression<Quantity>

Read Only No

MaximumTemperature

Specify upper bound for temperature

Type Expression<Quantity>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 801
Study

Read Only No

MaximumTurbulenceViscosityRatio

Specify upper bound for turbulent viscosity ratio

Type Expression<Quantity>

Read Only No

MinimumAbsolutePressure

Specify lower bound for absolute pressure

Type Expression<Quantity>

Read Only No

MinimumTemperature

Specify lower bound for temperature

Type Expression<Quantity>

Read Only No

MinimumTurbulenceDissipationRate

Specify lower bound for turbulent eddy frequency

Type Expression<Quantity>

Read Only No

MinimumTurbulenceEddyFrequency

Specify upper bound for turbulent eddy frequency

Type Expression<Quantity>

Read Only No

MinimumTurbulenceKineticEnergy

Specify lower bound for turbulent viscosity ratio

Type Expression<Quantity>

Read Only No

TemperaturePositivityRate

Specify positivity rate for temperature

Type Expression<Quantity>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
802 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

VolumeFractionCutoff

Specify cutoff for volume fraction

Type Expression<double>

Read Only No

SolutionSteering
Fine-tune or override solver settings elsewhere using solution steerings.

Properties
BlendFactor

Specify blend factor

Type Expression<Quantity>

Read Only No

FirstToHigherOrderBlending

Turn on first to higher order order blending.

Type bool

Read Only No

FlowType

Choose a flow type from given options.

Type Option

Possible Values: Hypersonic

Incompressible
Subsonic
Supersonic
Transonic

Read Only No

FMGSettings

Configure FMG initialization settings

Type FMGSettings

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 803
Study

SteeringSettings

Configure solution steering.

Type SteeringSettings

Read Only No

UseFMGInitialization

Use Fully-Multi Grid initialization method.

Type bool

Read Only No

UseSolutionSteering

Turn On solution steering.

Type bool

Read Only No

SpalartAllmarasModelConstants
Configure parameters for the turbulent flow to be calculated using the Spalart-Allmaras model.

Properties
Cb1

Set the parameter to model the Turbulent Production.

Type Expression<double>

Read Only No

Cb2

Set the parameter to model the Turbulent Production.

Type Expression<double>

Read Only No

Cproduction

Set the parameter to model the Turbulent Viscosity when strain/vorticity-based production option is
used.

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
804 of ANSYS, Inc. and its subsidiaries and affiliates.
Cv1

Set the parameter to model the Turbulent Viscosity.

Type Expression<double>

Read Only No

Cw2

Set the parameter to model the Turbulent Viscosity.

Type Expression<double>

Read Only No

Cw3

Set the parameter to model the Turbulent Viscosity.

Type Expression<double>

Read Only No

PrandtlNumber

Set Prandtl number (ratio of momentum diffusivity to thermal diffusivity).

Type Expression<double>

Read Only No

SpatialDiscretization
Configure interpolation of convection terms of quantities to control volumes

Properties
Advection

Configure advection schemes for governing equations

Type Advection

Read Only No

GradientMethod

Method for computing cell gradients.

Type Option

Possible Values: Automatic

GreenGaussCellBased
GreenGaussNodeBased
LeastSquaresCellBased

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 805
Study

Read Only No

PressureScheme

Select how pressure is interpolated from cells to faces

Type PressureScheme

Read Only No

SpeciesHybridSettings
Configure hybrid initialization settings

Properties
SpecifySpeciesParameters

Set specification of species property

Type bool

Read Only No

SpectralModel
Configure supported Spectral models.

Properties
Interval

Specify interval range.

Type IDictionary<string, Object>

Read Only No

NumberOfIntervals

Set number of bands.

Type int

Read Only No

Option

Allows to choose between different spectral models.

Type Option

Possible Values: Gray

MultipleBands

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
806 of ANSYS, Inc. and its subsidiaries and affiliates.
SpectralVariable

Choose Spectral Variable from the options.

Type Option

Possible Values: Frequency

WavelengthInVacuum
WavenumberInVacuum

Read Only No

StageOne
Configure the settings of first stage.

Properties
NumberOfIterations

Set the value of number of iterations.

Type int

Read Only No

StageTwo
Configure the settings of second stage.

Properties
CourantNumberUpdateInterval

Set the value of interval between consecutive update of Courant number.

Type int

Read Only No

NumberOfIterations

Set the value of number of iterations.

Type int

Read Only No

UpdateCourantNumber

Allows to choose when to update Courant number.

Type Option

Possible Values: Delayed

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 807
Study

Immediately

Read Only No

SteeringSettings
Configure solution steering.

Properties
ExplicitUnderRelaxationFactor

Specify explicit under-relaxation factor.

Type Expression<Quantity>

Read Only No

InitialCourantNumber

Specify an initial value for Courant number.

Type Expression<Quantity>

Read Only No

MaximumCourantNumber

Specify maximum limit for Courant number.

Type Expression<Quantity>

Read Only No

StageOne

Configure the settings of first stage.

Type StageOne

Read Only No

StageTwo

Configure the settings of second stage.

Type StageTwo

Read Only No

StreamwisePeriodicityModel
Allows to choose between different streamwise periodicity models.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
808 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
EnergyPeriodicityModel

Allows to choose between different energy periodicity models.

Type EnergyPeriodicityModel

Read Only No

FlowPeriodicityModel

Allows to choose between different flow periodicity models.

Type FlowPeriodicityModel

Read Only No

StressStrainModel
Configure Stress Strain Model.

Properties
Option

Allows to choose between different viscous and inviscid model.

Type Option

Possible Values: Inviscid

Viscous

Read Only No

SunDirectionVector
Configure components of sun direction vector.

Properties
Value

Specify vector components

Type List<Expression<Quantity>>

Read Only No

Swirl
Configure swirl in the model.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 809
Study

Properties
FanAxis

Set the fan axis direction vector.

Type List<Expression<Quantity>>

Read Only No

FanOrigin

Set the fan origin coordinate through which the fan rotation axis passes.

Type List<Expression<Quantity>>

Read Only No

HubRadius

Set the hub radius.

Type Expression<Quantity>

Read Only No

RadialVelocity

Set the radial velocity.

Type Expression<Quantity>

Read Only No

TangentialVelocity

Set the tangential velocity.

Type Expression<Quantity>

Read Only No

SymmetryBoundary
Set boundary.

Properties
BoundaryLocations

Set the boundary location.

Type List<string>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
810 of ANSYS, Inc. and its subsidiaries and affiliates.
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type BoundaryReferenceFrame

Read Only No

BoundaryType

Set different boundary type.

Type Option

Possible Values: Axis

Farfield
Inlet
Opening
Outlet
Symmetry
Wall

Read Only No

Energy

Set boundary conditions related to Energy.

Type Energy

Read Only No

Flow

Configure flow specification for the boundary.

Type Flow

Read Only No

ParticleBoundaryConditions

to be documented

Type ParticleBoundaryConditions

Read Only No

Radiation

Configure radiation specifications for boundary.

Type Radiation

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 811
Study

Regime

Configure flow regime.

Type Regime

Read Only No

Turbulence

Set turbulence related boundary conditions in the model.

Type Turbulence

Read Only No

UserScalarBoundaryConditions

to be documented

Type IDictionary<string, Object>

Read Only No

UserVectorBoundaryConditions

to be documented

Type IDictionary<string, Object>

Read Only No

TimeAdvancementMethod
Configure time advancement method for transient solutions

Properties
Method

Select method for non-iterative time advancement

Type Method

Read Only No

TimeOfDay
Configure parameters to specify hour and minutes.

Properties
Hour

Set parameters to specify hour.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
812 of ANSYS, Inc. and its subsidiaries and affiliates.
Type int

Read Only No

Minute

Set parameters to specify minutes.

Type int

Read Only No

TimeStepInitialization
Configure time step initialization.

Properties
Option

Select method to initialize variables at start of new time step.

Type Option

Possible Values: Extrapolation

PreviousTimeStep

Read Only No

TimeSteppingMethod
Allows to choose between different time stepping methods.

Properties
InitialTimeStepSize

Set magnitude of initial time step.

Type Expression<Quantity>

Read Only No

MaximumCellCourantNumber

Set Courant number for explicit formulation.

Type Expression<double>

Read Only No

MaximumChangeFactor

Set maximum limit to which the time step size can change at each time step.

Type Expression<double>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 813
Study

Read Only No

MaximumTimeStepSize

Set upper limit of time step.

Type Expression<Quantity>

Read Only No

MinimumChangeFactor

Set minimum limit to which the time step size can change at each time step.

Type Expression<double>

Read Only No

MinimumTimeStepSize

Set lower limit of time step.

Type Expression<Quantity>

Read Only No

NumberOfFixedTimeSteps

Set the number of fixed-size time steps that should be performed before the size of the time step starts
to change.

Type int

Read Only No

TimeStepSize

Set magnitude of (physical) time step.

Type Expression<Quantity>

Read Only No

TruncationErrorTolerance

Set the threshold value to which the computed truncation error is compared.

Type Expression<double>

Read Only No

TotalPressureFrame
Select reference frame for total pressure

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
814 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Option

Select total pressure reference frame among global and boundary frames.

Type Option

Possible Values: BoundaryFrame

GlobalFrame

Read Only No

TransientScheme
Configure integration of transient terms in governing equations

Properties
TransientDefaultSetting

Specify default transient scheme

Type Option

Possible Values: BoundedSecondOrderBackwardEuler

FirstOrderBackwardEuler
FirstOrderExplicit
SecondOrderExplicit
TimeExplicit
UnboundedSecondOrderBackwardEuler

Read Only No

TransientEquation

Configure transient scheme for an equation.

Type IDictionary<string, Object>

Read Only No

TransientSettings
Specifies how the Damping layer must behave.

Properties
AcousticsTransientScheme

Choose between different time schemes

Type Option

Possible Values: CrankNicolson

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 815
Study

FirstOrderExplicit
FirstOrderImplicit
SecondOrderExplicit
SecondOrderImplicit

Read Only No

IterationsPerTimeStep

Number of iterations for schemes.

Type int

Read Only No

TranslationVector
Set the translational offset of periodic interface.

Properties
SpecifiedTranslationVector

Set the user specified translational offset of periodic interface

Type List<Expression<Quantity>>

Read Only No

Transmissivity
Set transmissivity parameters.

Properties
DiffuseHemispherical

Specify diffuse hemispherical transmissivity.

Type Expression<Quantity>

Read Only No

DirectIR

Specify direct infra-red transmissivity.

Type Expression<Quantity>

Read Only No

DirectVisible

Specify direct visible transmissivity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
816 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Expression<Quantity>

Read Only No

TurbSpeciesEnergyLESSettings
Configure constants for turbulence-energy species calculations

Properties
DynamicScalarFlux

Enable/Disable the dynamic computation of turbulent model

Type bool

Read Only No

Turbulence
Configure Turbulence initial conditions.

Properties
HydraulicDiameter

Set the hydraulic diameter.

Type Expression<Quantity>

Read Only No

LaminarKineticEnergy

Set values for the laminar kinetic energy.

Type Expression<Quantity>

Read Only No

MomentumThickness

Set the momentum thickness.

Type Expression<Quantity>

Read Only No

Option

Allows to choose different methods to specify turbulence.

Type Option

Possible Values: HighIntensityAndViscosityRatio

HighViscosityRatio

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 817
Study

IntensityAndHydraulicDiameter
IntensityAndLengthScale
IntensityAndViscosityRatio
LowIntensityAndViscosityRatio
LowViscosityRatio
MediumIntensityAndViscosityRatio
MediumViscosityRatio
TransportVariables
ViscosityRatio

Read Only No

SubgridKineticEnergy

Set values for the sub grid kinetic energy.

Type Expression<Quantity>

Read Only No

TurbulenceDissipationRate

Set the turbulence dissipation rate.

Type Expression<Quantity>

Read Only No

TurbulenceEddyFrequency

Set the turbulence eddy frequency.

Type Expression<Quantity>

Read Only No

TurbulenceIntensity

Set the hydraulic intensity.

Type Expression<Quantity>

Read Only No

TurbulenceIntermittency

Set the turbulence intermittency.

Type Expression<Quantity>

Read Only No

TurbulenceKineticEnergy

Set values for the turbulence kinetic energy.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
818 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Expression<Quantity>

Read Only No

TurbulenceLengthScale

Set the turbulence length scale.

Type Expression<Quantity>

Read Only No

TurbulenceModifiedViscosity

Set the turbulence viscosity.

Type Expression<Quantity>

Read Only No

TurbulenceViscosityRatio

Set the turbulence viscosity ratio.

Type Expression<Quantity>

Read Only No

Turbulence
Set turbulence related boundary conditions in the model.

Properties
HydraulicDiameter

Set the hydraulic diameter.

Type Expression<Quantity>

Read Only No

LaminarKineticEnergy

Set values for the laminar kinetic energy.

Type Expression<Quantity>

Read Only No

NumberOfVortices

Specify the number of vortices.

Type Expression<double>

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 819
Study

Read Only No

Option

Allows to choose different methods to specify direction.

Type Option

Possible Values: DefaultIntensityAndAutocomputeLengthScale

HighIntensityAndViscosityRatio
HighViscosityRatio
IntensityAndAutoComputeLength
IntensityAndHydraulicDiameter
IntensityAndLengthScale
IntensityAndViscosityRatio
LowIntensityAndViscosityRatio
LowViscosityRatio
MediumIntensityAndViscosityRatio
MediumViscosityRatio
TransportVariables
ViscosityRatio
kAndEddyViscosityRatio
kAndLengthScale

Read Only No

ReynoldsStresses

Configure Reynolds stress model.

Type ReynoldsStresses

Read Only No

SyntheticInflowTurbulence

Choose option, for Synthetic Inflow Turbulence

Type Option

Possible Values: HarmonicTurbulenceGenerator

NoPerturbations
RandomPerturbations
SpectralSynthesizer
VortexMethod

Read Only No

TurbulenceDissipationRate

Set the turbulence dissipation rate.

Type Expression<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
820 of ANSYS, Inc. and its subsidiaries and affiliates.
TurbulenceEddyFrequency

Set the turbulence eddy frequency.

Type Expression<Quantity>

Read Only No

TurbulenceIntensity

Set the hydraulic intensity.

Type Expression<Quantity>

Read Only No

TurbulenceKineticEnergy

Set values for the turbulence kinetic energy.

Type Expression<Quantity>

Read Only No

TurbulenceLengthScale

Set the turbulence length scale.

Type Expression<Quantity>

Read Only No

TurbulenceModifiedViscosity

Set the turbulence viscosity.

Type Expression<Quantity>

Read Only No

TurbulenceViscosityRatio

Set the turbulence viscosity ratio.

Type Expression<Quantity>

Read Only No

WallRoughness

Configure inputs for defining wall roughness in turbulent calculations.

Type WallRoughness

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 821
Study

TurbulenceEnergyInteraction
Configure Energy Model for turbulence interaction.

Properties
EnergyNearWallTreatment

Incorporate near wall treatment for energy interaction model.

Type EnergyNearWallTreatment

Read Only No

NearWallTreatmentThermalEffects

Enable to incorporate near-wall treatment for energy interaction model.

Type bool

Read Only No

TurbulenceEnergyInteractionConstants

Set turbulence energy interaction constants.

Type TurbulenceEnergyInteractionConstants

Read Only No

TurbulenceEnergyInteractionConstants
Set turbulence energy interaction constants.

Properties
TurbulencePrandtlNumber

Set turbulence Prandtl number.

Type Expression<double>

Read Only No

WallPrandtlNumber

Set wall Prandtl number.

Type Expression<double>

Read Only No

TurbulenceEnergySpeciesInteraction
Set values for turbulence-energy species calculation

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
822 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
TurbSpeciesEnergyLESSettings

Configure constants for turbulence-energy species calculations

Type TurbSpeciesEnergyLESSettings

Read Only No

TurbulenceHybridSettings
Configure turbulence hybrid settings.

Properties
TurbulenceIntensity

Set the hydraulic intensity.

Type Expression<Quantity>

Read Only No

TurbulenceViscosityRatio

Set the turbulence viscosity ratio.

Type Expression<Quantity>

Read Only No

UseAveragedQuantities

Turn On to enable hybrid setting.

Type Option

Possible Values: Off

On

Read Only No

TurbulenceModel
Configure Turbulence Model.

Properties
LowPressureBoundarySlip

Enable/disable Low Pressure Boundary slip condition; default value is False.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 823
Study

Read Only No

Option

Allows to choose between different turbulence models.

Type Option

Possible Values: DetachedEddySimulation

DirectNumericalSimulation
Laminar
LargeEddySimulation
ReynoldsAveragedNS
ScaleAdaptiveSimulation

Read Only No

RANSModel

Configure options for specifying the viscous model.

Type RANSModel

Read Only No

TurbulenceSpeciesInteraction
Set values for turbulent species calculation

Properties
TurbulenceSpeciesInteractionConstants

Configure constants for turbulent species calculations

Type TurbulenceSpeciesInteractionConstants

Read Only No

TurbulenceSpeciesInteractionConstants
Configure constants for turbulent species calculations

Properties
TurbulenceSchmidtNumber

Set turbulence schmidt number

Type Expression<double>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
824 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedConvergence
Create user defined convergence.

Properties
Option

Allows to specify user defined convergence.

Type Option

Possible Values: LogicalExpression

None

Read Only No

Velocity
Allows to specify the velocity direction in different coordinate system.

Properties
CartesianVelocityComponents

Set the velocity component in Cartesian coordinate system.

Type List<Expression<Quantity>>

Read Only No

CylindricalVelocityComponents

Set the velocity component in cylindrical coordinate system.

Type List<Expression<Quantity>>

Read Only No

Option

Allows to choose between cartesian and cylindrical coordinate system.

Type Option

Possible Values: CartesianComponents

CylindricalComponents

Read Only No

Velocity
Configure velocity specifications for the boundary.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 825
Study

Properties
Components

Allows to specify the velocity component in different coordinate system.

Type Components

Read Only No

GaugeStaticPressure

Set the gauge static pressure value.

Type Expression<Quantity>

Read Only No

Magnitude

Specify velocity magnitude.

Type Expression<Quantity>

Read Only No

Option

Select option for velocity specification.

Type Option

Possible Values: Components

MagnitudeAndDirection

Read Only No

ViewFactors
Configure settings for computing the view factors.

Properties
Basis

Set how surfaces are defined for calculation of view factor.

Type Option

Possible Values: ClusterToCluster

FaceToFace

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
826 of ANSYS, Inc. and its subsidiaries and affiliates.
Method

Set method for computing view factors.

Type Option

Possible Values: Hemicube

RayTracing

Read Only No

Parameters

Configure settings related to the hemicube and ray tracing methods for computing the view factors.

Type Parameters

Read Only No

Surfaces

Set Surface, the geometric orientation of surface pairs with respect to each other when using hemicube
method.

Type Option

Possible Values: Blocking

NonBlocking

Read Only No

ViewFactorsAndClustering
Configure parameters for surface clusters and view factors calculation.

Properties
Clustering

Configure methods and settings for creating surface clusters.

Type Clustering

Read Only No

FileName

Specify file name.

Type string

Read Only No

ViewFactors

Configure settings for computing the view factors.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 827
Study

Type ViewFactors

Read Only No

WallBoundary
Set boundary.

Properties
BoundaryLocations

Set the boundary location.

Type List<string>

Read Only No

BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type BoundaryReferenceFrame

Read Only No

BoundaryType

Set different boundary type.

Type Option

Possible Values: Axis

Farfield
Inlet
Opening
Outlet
Symmetry
Wall

Read Only No

Energy

Set boundary conditions related to Energy.

Type Energy

Read Only No

Flow

Configure flow specification for the boundary.

Type Flow

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
828 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

ParticleBoundaryConditions

to be documented

Type ParticleBoundaryConditions

Read Only No

Radiation

Configure radiation specifications for boundary.

Type Radiation

Read Only No

Regime

Configure flow regime.

Type Regime

Read Only No

Turbulence

Set turbulence related boundary conditions in the model.

Type Turbulence

Read Only No

UserScalarBoundaryConditions

to be documented

Type IDictionary<string, Object>

Read Only No

UserVectorBoundaryConditions

to be documented

Type IDictionary<string, Object>

Read Only No

WallRoughness
Configure inputs for defining wall roughness in turbulent calculations.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 829
Study

Properties
Option

Configure inputs for defining wall roughness in turbulent calculations.

Type Option

Possible Values: Rough

Smooth

Read Only No

RoughnessConstant

Set the roughness constant.

Type Expression<Quantity>

Read Only No

RoughnessHeight

Set the roughness height.

Type Expression<Quantity>

Read Only No

WallThickness
Allows to choose between zero thickness wall or thick wall.

Properties
Thickness

Set the thickness.

Type Expression<Quantity>

Read Only No

WallMaterialName

Set the material for current wall.

Type DataObject

Read Only No

WallVelocity
Allows to choose between stationary or moving wall.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
830 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
MovingWall

Configure moving wall in the model.

Type MovingWall

Read Only No

Option

Allows to choose between stationary or moving wall.

Type Option

Possible Values: Moving

Stationary

Read Only No

Customization Data Entities

UserCommands
Defines user commands to be sent to the solver.

Properties
No Properties.

Structural Data Entities

BoundaryCondition
BoundaryCondition is the abstraction over load and constraints.

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Connection
This is a class that is meant to define different kinds of connections like Contact, Joint, Spring, Beam
etc. via one of its behaviors when set Non creatable by a user.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 831
Study

Properties
Behavior

It displays the contact behavior referenced by this connection.

Type InterfaceBehavior

Read Only No

CreationMode

It tells if this connection was created automatically by the program or created manually by the user

Type ConnectionCreationMode

Read Only No

Location1

This is the first location of the connection. For contact, this normally refers to the source of the contact.

Type LocationSet

Read Only No

Location1Bodies

It displays the bodies of the entities referenced in Location 1 of the connection.

Type string

Read Only Yes

Location2

This is the second location of the connection. For contact, this normally refers to the target of the
contact.

Type LocationSet

Read Only No

Location2Bodies

It displays the bodies of the entities referenced in Location 2 of the connection.

Type string

Read Only Yes

ConnectionBehavior
ConnectionBehavior is an abstraction over all kinds of connection behaviors such as JointBehavior,
BeamBehavior, LinkBehavior, SpringBehavior and ContactBehavior.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
832 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
No Properties.

ConnectionStatisticalMeasures
This class represents the connection confidence percentage data. It get run-time added to an automatic
generated contacts whne the generate confidence setting is turned on.

Properties
PercentageConfidenceLevel

Show the confidence level for the automatic generated connections

Type double

Read Only Yes

Constraint
Constraint is an abstraction over all the boundary condtions that provide known values and does not
require solution for a given location in the model such as Supports, Displacements, Rotations etc.

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

ContactBehavior
ContactBehavior is ConnectionBehavior to model various kinds of contact behaviors available from
Mechanical Solvers such as contact types and their formulations.

Properties
ContactType

Type of contact for eg. Bonded, Frictional, Frictionless, etc.

Type ContactType

Read Only No

ContactMaterialProperties
This is a class resposible for setting material properties at the contact interface. It is run-time added if
the contact is structure of thermal and formulation is not MPC.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 833
Study

Properties
No Properties.

ContactPinball
This is a class resposible for setting pinball value for contact detection.

Properties
DefineBy

This propertry decides whether it should use program controlled value or a manually entered factor or
value.

Type ValueDefineBy

Read Only No

Value

Enter the factor or value

Type Expression<Quantity>

Read Only No

ContactProperties
This class defines contact properties that can change per contact pair such as Symmetry Behavior etc.
as exposed by Mechanical solvers.

Properties
SymmetryBehavior

Switch to turn on symmetric contact - Additional contact pair will be generated by swapping Location
1 and Location 2

Type SymmetryBehavior

Read Only No

ContactSubObject
This is the base class for pinball, penetration tolerance and the slip tolerance.

Properties
DefineBy

This propertry decides whether it should use program controlled value or a manually entered factor or
value.

Type ValueDefineBy

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
834 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

Value

Enter the factor or value

Type Expression<Quantity>

Read Only No

Convection
Convection is a Scalar Load to precribe a given value of heat flux at a given location in a model in
thermal solutions.

Properties
AmbientTemperature

Value of Ambient Temperature of Radiation.

Type Expression<Quantity>

Read Only No

FilmCoefficientMatrix

Matrix type for the film coefficient: Diagonal or Consistent.

Type ConvectionMatrixType

Read Only No

Location

Location of the boundary condition

Type LocationSet

Read Only No

Magnitude

Applied value of load

Type Expression<Quantity>

Read Only No

Current
Current is a Scalar Load to precribe a given value of current at a given location in a model in electric
solutions.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 835
Study

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Magnitude

Applied value of load

Type Expression<Quantity>

Read Only No

CutTolerance
It denotes the tolerance upto which nodes below the separation surface are considered to be above
the surface. It has an affect of shifting separation surface downwards by this distance.

Properties
Tolerance

Value of cut tolerance

Type Expression<Quantity>

Read Only No

ToleranceSpecification

Choose how cut tolerance is defined : Program Controlled or Manual

Type BoltDefineBy

Read Only No

Displacement
Displacement is a Vector Constraint used to prescribe a given value of displacement at a given location
in the model

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
836 of ANSYS, Inc. and its subsidiaries and affiliates.
ElectricConductance
This class represents the eletric conductance at the contact interface. It gets added when selected
physics includes electric and formulation is not MPC.

Properties
Conductance

Contact conductance value

Type Quantity

Read Only No

ConductanceControl

Switch to use program controlled conductance value or enter value.

Type ConductanceControlType

Read Only No

Equipotential
This is a class that creates an equal voltage on the selection applied.

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Force
Force is a Vector Load to prescribe external force to a given model at a given location.

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

HeatFlow
Heat Flow is a Scalar Load to precribe a given value of heat flow at a given location in a model in
thermal solutions.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 837
Study

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Magnitude

Applied value of load

Type Expression<Quantity>

Read Only No

HeatFlux
Heat Flux is a Scalar Load to precribe a given value of heat flux at a given location in a model in thermal
solutions.

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Magnitude

Applied value of load

Type Expression<Quantity>

Read Only No

HeatGeneration
Heat Generation is a Scalar Load to prescribe a uniform generation rate internal to a body.

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
838 of ANSYS, Inc. and its subsidiaries and affiliates.
Magnitude

Applied value of load

Type Expression<Quantity>

Read Only No

InertiaLoad
InertiaLoad is a Vector Load experienced by a body by the virtue of being in an accelerated reference
frame due to its mass properties. It can be prescribed via an Acceleration, Angular Velocity or Angular
Acceleration at a given location in the model.

Properties
LoadType

Load Type of Inertia Load such as Acceleration, Angular Velocity or Angular Acceleration.

Type VectorType

Read Only No

Location

Location of the boundary condition

Type LocationSet

Read Only No

InterfaceGenerator
InterfaceGenerator is class to define various settings for detection of Interface Conditions such a contacts.

Properties
ConnectionBehaviorCreation

It allows you to create one connection behavior and share it or create separate ones for each one of
searched interfaces.

Type InterfaceBehaviorCreation

Read Only No

GenerateFixedJoints

Switch to activate generation of fixed joints

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 839
Study

GenerateRevoluteJoints

Switch to activate generation of revolute joints

Type bool

Read Only No

InterfaceToleranceSpecification

It allows to let either program decides the tolerance value for you or you choose to input your own
tolerance value

Type InterfaceToleranceSpecification

Read Only No

InterfaceType

Type of inerfaces to be generated. Select from Contact, Joint and Mesh Interface.

Type InterfaceType

Read Only No

Location

Location considered to search for interfaces.

Type LocationSet

Read Only No

Tolerance

Tolerance value used to search for interfaces

Type Quantity

Read Only No

Load
Load is Boudary Condition to prescribe external load to a given location in a model. It is an abstraction
over scalar and vector loads.

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
840 of ANSYS, Inc. and its subsidiaries and affiliates.
MechanicalPhysicsOptions
MechanicalPhysicsOptions is a class that represents various ways through which a physics option can
be applied to bodies. For example various stress states to be analyzed such as 3DStress State, Plane
Stress, Plane Strain, Axisymmetric, etc.

Properties
Location

The region participating in the solution.

Type LocationSet

Read Only No

UseInertialReferenceFrame

For Rigid bodies, control to model them using a single Inertial Frame or individual ones

Type bool

Read Only No

Moment
Moment is a vector load to prescribe an external moment load to a given location in a model.

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

OutputControls
OutputControls is a class that specifes the list of output specifications(such as Deformation, Stress,
Strain) to control the "what" goes in result file. It also controls "how frequently" results are stored.

Properties
No Properties.

Pressure
Pressure is a scalar load to prescribe an external pressure to a given location(face or element faces) in
a model always in a direction normal to the location surface.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 841
Study

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Magnitude

Applied value of load

Type Expression<Quantity>

Read Only No

Radiation
Radiation is a scalar load to prescribe an external Radiation to a given location in a model.

Properties
Emissivity

Value of Emissivity of Radiation.

Type Quantity

Read Only No

Location

Location of the boundary condition

Type LocationSet

Read Only No

Magnitude

Applied value of load

Type Expression<Quantity>

Read Only No

ScalarConstraint
ScalarConstraint is abstraction over constraints that are scalar by nature such as temperature in thermal
solutions or voltage in electric solutions

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
842 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Magnitude

Applied value of constraint

Type Expression<Quantity>

Read Only No

ScalarLoad
ScalarLoad is abstraction over loads that are scalar by nature such as pressure Radiation etc.

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Magnitude

Applied value of load

Type Expression<Quantity>

Read Only No

SolidModelingOptions
SolidModelingOptions is a class that encapsulates various advanced solver element formulations available
to users. Normally an end user never deals with them as solver defaults are good enough, but we do
offer a scheme to override it.

Properties
BrickIntegrationType

IntegrationType of elements used by solvers such as Full or Reduced.

Type IntegrationType

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 843
Study

Support
Support is a constraint to precribe zero values to active degrees of freedom for a given model at a
given location.

Properties
FixedDOFs

String array of the fixed degrees of freedom, e.g., ["X","Y","Z","RX","RY","RZ"]

Type String[]

Read Only No

Location

Location of the boundary condition

Type LocationSet

Read Only No

TemperatureCondition
Temperature Condition is scalar load to prescribe temperature to a given location(bodies or elements)
in a model in pure structural solutions.

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Magnitude

Applied value of load

Type Expression<Quantity>

Read Only No

TemperatureConstraint
Temperature Constraint is a scalar constraint to precribe known value of temperature in solutions that
suppport thermal degrees of freedom.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
844 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Magnitude

Applied value of constraint

Type Expression<Quantity>

Read Only No

ThermalConductance
This class represents the thermal conductance at the contact interface. It gets added when selected
physics includes thermal and formulation is not MPC.

Properties
Conductance

Contact conductance value

Type Quantity

Read Only No

ConductanceControl

Switch to use program controlled conductance value or enter value.

Type ConductanceControlType

Read Only No

Vector
Vector is class used by all Boundary Conditions and Connection that support a Vector Behavior.

Properties
DefineBy

This property sets the type of vector specification which could be by Components or MagnitudeAndDir-
ection or NormalToSurface.

Type VectorDefineBy

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 845
Study

RelativeTo

Vector components or direction has been specified with respect to this reference frame.

Type ReferenceFrame

Read Only No

VectorByComponents
VectorByComponents is class to define a vector by Components.

Properties
Component1

The x component

Type Expression<Quantity>

Read Only No

Component2

The y component

Type Expression<Quantity>

Read Only No

Component3

The z component

Type Expression<Quantity>

Read Only No

CoordinateType

The type of coordinate system to be used which could be Cartesian or Cylindrical or Spherical.

Type TripletType

Read Only Yes

RelativeTo

Vector components has been specified with respect to this reference frame.

Type ReferenceFrame

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
846 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorByGeometry
ByGeometry is class to define a vector using geometry.

Properties
Magnitude

Magnitude of the vector

Type Expression<Quantity>

Read Only No

VectorConstraint
A Vector Constraint is constraint that has an underneath vectors like Displacement, Velocity etc

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

VectorLoad
VectorLoad is an abstraction over loads that are vector by nature such as Force, Moment, Traction etc.

Properties
Location

Location of the boundary condition

Type LocationSet

Read Only No

Voltage
Voltage is a scalar constraint to precribe known value of voltage in solutions that suppport electric de-
grees of freedom.

Properties
Location

Location of the boundary condition

Type LocationSet

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 847
Study

Read Only No

Magnitude

Applied value of constraint

Type Expression<Quantity>

Read Only No

Mapdl Data Entities

ConnectionTrimmingOptions
ConnectionTrimmingOptions is a class to represents various trimming options available for contact
connection.

Properties
Tolerance

Tolerance to be used when trimming is on.

Type Quantity

Read Only No

Type

Trim Type to control trimming such as keeping it on, off or Program Controllled.

Type TrimType

Read Only No

ContactFormulation
ContactFormulation is a class to represents various contact formulations as available from MAPDL
solver

Properties
AutoAsymmetryBehavior

A flag to notify the program if auto-asymmetry should be used in the physics solution.

Type AutoAsymmetryBehavior

Read Only No

DetectionType

Specify the location of contact detection to be used in the analysis in order to obtain a good convergence.

Type ContactDetectionPoint

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
848 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

Formulation

Set the contact formulation to be used by the solver for a particular contact pair.

Type FormulationType

Read Only No

PhysicsSelection

Method for selecting the physics type: Program Controlled or Manual

Type ContactPhysicsSelection

Read Only No

PhysicsType

Specified physics type(s) for the contact formulation

Type PhysicsType

Read Only No

GeneralSolutionControls
GeneralSolutionControls is Solver Settings class that allows defining some general solution controls
such as unit sytems, Equation solver types etc. as exposed by MAPDL solver.

Properties
LimitSearchToRange

Activate search to a given range of frequencies for frequency domain solutions as available from MAPDL
solver.

Type YesOrNo

Read Only No

MatrixSolver

Equation Solver Types as available from MAPDL solver.

Type EquationSolverType

Read Only No

MaxModesToFind

Maximum modes to find for modal solutions as available from MAPDL solver.

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 849
Study

Read Only No

RangeMaximum

A value of maximum frequency for frequency domain solutions with a given range as available from
MAPDL solver.

Type Quantity

Read Only No

RangeMinimum

A value of minimum frequency for frequency domain solutions with a given range as available from
MAPDL solver.

Type Quantity

Read Only No

SolverDamping

An enumeration for damped modal solver types as available from MAPDL solver.

Type DampedSolverType

Read Only No

SolverUnitSystem

Solver unit systems as available from MAPDL solver.

Type string

Read Only No

MAPDLFunctionProvider
This is a class that implements MAPDL expressions like AllContacts() etc.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

MapdlLaunchControls
MapdlLaunchControls is class that allows defining solver launch controls such as Solver file directory,
various solver input file names as exposed by MAPDL solver.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
850 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
ComponentDataFileName

A name for auxiliary solver input file which contains all nodal and elemental components created in
MAPDL solution.

Type string

Read Only No

ConnectionElementsDataFileName

A name for auxiliary solver input file which contains all connection elements in MAPDL solution.

Type string

Read Only No

ContactPairOutput

Activate Contact Pair Output in MAPDL solution.

Type ContactPairOutputYesNo

Read Only No

DeleteWorkFiles

Override to keep all solver generated files in MAPDL solution.

Type YesOrNo

Read Only No

DistributedSolve

Turn Off or On Distributed solution for MAPDL solver.

Type OnOffSwitch

Read Only No

InputDataFileName

A name for master solver input file which assembles all other auxiliary input files (MeshDataFileName,
ComponentDataFileName, etc.) for MAPDL Solver.

Type string

Read Only No

JobName

A name for the job file in MAPDL solution.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 851
Study

Type string

Read Only No

LoadElementsDataFileName

A name for auxiliary solver input file which contains all load elements in MAPDL solution.

Type string

Read Only No

MeshDataFileName

A name for auxiliary solver input file which contains all mesh information(nodes and elements) for all
participating bodies in MAPDL solution.

Type string

Read Only No

NumberOfProcessors

Number of Processors to use for distributed solution in MAPDL solver.

Type uint

Read Only No

OutputListFileName

A name for output file in MAPDL solution.

Type string

Read Only No

SolverFilesDirectory

Solver Files Directory where solution happens for MAPDL solver.

Type string

Read Only Yes

SolverMode

Run the solver in batch mode just while solving or keep it live.

Type MAPDLSolverMode

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
852 of ANSYS, Inc. and its subsidiaries and affiliates.
OutputSpecification
OutputSpecification is a class that defines each individual item that can be controlled to be stored in
a result file such as Deformation, Stress or Strain.

Properties
EquallySpacedTimePoints

Time Points frequency of OutputSpecification

Type int

Read Only No

Frequency

Frequency of OutputSpecification, how often a given output type is written to result file

Type CalculationFrequency

Read Only No

Location

Location for OutputSpecification

Type LocationSet

Read Only No

OutputType

OutputType for OutputSpecification such as Deformation, Stress or Strain

Type OutputType

Read Only No

RecurrenceRate

RecurrenceRate of OutputSpecification

Type int

Read Only No

OutputSpecifications
OutputSpecifications is a class that is repository of individual OutputSpecification such as Deformation,
Stress or Strain.

Properties
No Properties.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 853
Study

ZeroThermalStrainTemperature
ZeroThermalStrainTemperature is a class that hold temperature at zero thermal strain.

Properties
Magnitude

Magnitude of ZeroThermalStrainTemperature

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
854 of ANSYS, Inc. and its subsidiaries and affiliates.
System Coupling

System Coupling Setup

This container holds Set Up data for an instance of System Coupling.

Methods
CreateDataTransfer
Creates a data transfer.

Return The new data transfer that was created.

Type DataReference

Required Arguments

Name The name for this data transfer.

Type string

Optional Arguments

SourceParticipant The source of this data transfer.

Type DataReference

SourceRegion The source Region for this data transfer.

Type DataReference

SourceVariable The source Variable for this data transfer.

Type DataReference

TargetParticipant The destination for this data transfer.

Type DataReference

TargetRegion The destination region for this data transfer.

Type DataReference

TargetVariable The destination variable for this data transfer.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 855
System Coupling

Example
The following example demonstrates creation of a data transfer. It is assumed that user had created two
participants (e.g. Transient Structural and Fluid Flow(Fluent) and connected to System Coupling System.
System Coupling User's Guide in help documentation provides information on "Tutorial: Oscillating Plate
with Two-Way Fluid-Structure Interaction". The same information can be referred to see how two participants
can be setup and connect to System Coupling System.

# Get System Couplng Setup

system1 = GetSystem(Name="SC")
setup1 = system1.GetContainer(ComponentName="Setup")
# Get source participant (e.g. Transient Structural) , source region and source variable
participant1 = setup1.GetParticipant(Name="Solution")
region1 = participant1.GetRegion(Name="Fluid Solid Interface")
variable1 = region1.GetVariable(Name="Incremental Displacement")
# Get target participant (e.g. Fluid Flow(Fluent), target region and target variable
participant2 = setup1.GetParticipant(Name="Solution 1")
region2 = participant2.GetRegion(Name="wall_deforming")
variable2 = region2.GetVariable(Name="displacement")
# Create a data transfer
dataTransfer1 = setup1.CreateDataTransfer(
Name="Data Transfer",
SourceParticipant=participant1,
SourceRegion=region1,
SourceVariable=variable1,
TargetParticipant=participant2,
TargetRegion=region2,
TargetVariable=variable2)

ExportSCIFile
Writes the system coupling input file at the specified path.

Required Arguments

Path Fully qualified path of the SCI File.

Type string

GetAnalysisSettings
Returns the analysis settings entity in a container.

Return Data reference of the analysis settings in the container.

Type DataReference

GetDataTransfer
Returns the data transfer of a given name in a container.

Return The data transfer that matches the specified name.

Type DataReference

Required Arguments

Name The name or display name of the data transfer.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
856 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

GetDataTransfers
Returns the collection of data transfers in a container. If no data transfers are in the container, the col-
lection is empty.

Return Collection of the data transfers in the container.

Type DataReferenceSet

GetDebugOutputControls
Returns the debug output controls from a system coupling setup container.

Return Data reference of the debug output controls in the container.

Type DataReference

GetExpertSettings
Returns the expert settings entity from a system coupling setup container.

Return Data reference of the expert settings in the container.

Type DataReference

GetIntermediateRestartDataOutputControls
Returns the intermediate result files output controls from a system coupling setup container. Renamed
from ResultFiles to RestartData to avoid confusion for MAPDL users.

Return Data reference of the intermediate result files output controls in the
container.

Type DataReference

GetParticipant
Returns the participant with a given name from a system coupling setup container.

Return The participant that matches the specified name.

Type DataReference

Required Arguments

Name The internal name or display name of the participant.

Type string

GetParticipants
Returns the collection of participants in a container. If no participants are in the container, the collection
is empty.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 857
System Coupling

Return Collection of the participants in the container.

Type DataReferenceSet

GetSequenceControls
Returns the sequence controls from a system coupling setup container.

Return Data reference of the sequence controls in the container.

Type DataReference

ReadRestartPoints
Generates a list of restart points in analysis settings

Data Entities
AnalysisSettings
The entity to store the analysis settings for a coupling run.

Properties
AnalysisType

The coupled analysis type.

Type CoupledAnalysisType

Read Only No

DisableSolutionUpdate

This flag disables updates if restarts are not supported and solution data exists

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

DurationDefinedBy

This property specifies how we should determine the end of the coupling run.

Type DurationType

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
858 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

EndTime

The end time for the coupling run

Type Quantity

Read Only No

Initialization

The initialziation setting.

Type InitializationType

Read Only No

MaximumIteration

The maximum number of iterations per coupling step for the coupling run.

Type int

Read Only No

MinimumIteration

The minimum number of iterations per coupling step for the coupling run.

Type int

Read Only No

NumberOfSteps

The number of time steps for the coupling run.

Type int

Read Only No

RestartStep

The restart step for the coupling run.

Type int

Read Only No

RestartTime

The restart time for the coupling run.

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 859
System Coupling

Read Only No

StepSize

The step size for the coupling run.

Type Quantity

Read Only No

DataTransfer
Entity to store a data transfer information.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsSuppressed

Suppression state of the entity.

Type bool

Read Only No

SourceParticipant

Participant system providing the data.

Type DataReference

Read Only No

SourceRegion

Participant region providing the data.

Type DataReference

Read Only No

SourceVariable

Variable provided by the source participant.

Type DataReference

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
860 of ANSYS, Inc. and its subsidiaries and affiliates.
TargetParticipant

Participant consuming the data.

Type DataReference

Read Only No

TargetRegion

Participant region consuming the data.

Type DataReference

Read Only No

TargetVariable

Variable consumed by the target participant.

Type DataReference

Read Only No

TransferSettings

Settings to specify how the data transfers are executed.

Type DataReference

Read Only No

Methods
Delete

Deletes a specified data transfer.

Duplicate

Duplicates the data transfer.

Return Data reference to the duplicate data transfer.

Type DataReference

GetSettings

Returns the settings for a specified data transfer.

Return The data transfer settings.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 861
System Coupling

SetSuppression

Suppresses or unsuppresses a data transfer

Required Arguments

Suppressed The boolean value to specify if the item should be suppressed or unsuppressed

Type bool

DataTransferSettings
Entity to store the settings for the data transfer control.

Properties
ConvergenceTarget

The target value used when evaluating convergence of the data transfer within a coupling iteration.

Type double

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Ramping

Setting that defines the ramping.

Type RampingType

Read Only No

TransferAt

Setting that defines when the transfers should happen.

Type TransferAtType

Read Only No

UnderRelaxationFactor

Convergence stability factor for highly non-linear couplings.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
862 of ANSYS, Inc. and its subsidiaries and affiliates.
DebugOutputControls
Entity to store the debug level information for solution log.

Properties
AnalysisInitialization

This setting controls the level of output from the “Analysis Initialization” until the “Solution” synchron-
ization point.

Type DebugLevel

Read Only No

ConvergenceChecks

This setting controls the level of output from the “Check Convergence” synchronization point until the
next synchronization point, which may be either “Shutdown” or “Solution.”

Type DebugLevel

Read Only No

DataTransfersLevel

This setting provides the default level for the different kinds of debug output. If this entry is set and
another specific entry (e.g., SourceMeshCoords) also exists, then the output level for the specific entry
will override the level set here.

Type DebugLevel

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

GlobalLevel

This setting provides the default level for the different sections of debug output. If this entry is set and
another specific entry (e.g., Startup) also exists, then the output level for the specific entry will override
the level set here.

Type DebugLevel

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 863
System Coupling

ParticipantConnection

This setting controls the level of output from the end of the setup validation until the “Analysis Initaliz-
ation” synchronization point.

Type DebugLevel

Read Only No

Shutdown

This setting controls the level of output after the “Shutdown” synchronization point.

Type DebugLevel

Read Only No

SolutionInitialization

This setting controls the level of output during the setup of coupling steps and iterations. This output
does not include information related to the data transfers.

Type DebugLevel

Read Only No

SourceData

This setting controls the level of output for the source data in all data transfers.

Type DebugLevel

Read Only No

SourceMeshCoordinates

This setting controls the level of output for mesh coordinates of the source region in all data transfers.

Type DebugLevel

Read Only No

SourceMeshTopology

This setting controls the level of output for mesh topology (elements and nodes) of the source region
in all data transfers.

Type DebugLevel

Read Only No

Startup

This setting controls the level of output from the start of the coupling service until creation of the
“Summary of SC Setup” banner in the SCL file.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
864 of ANSYS, Inc. and its subsidiaries and affiliates.
Type DebugLevel

Read Only No

TargetData

This setting controls the level of output for the target data in all data transfers.

Type DebugLevel

Read Only No

TargetMeshCoordinates

This setting controls the level of output for mesh coordinates of the source region in all data transfers.

Type DebugLevel

Read Only No

TargetMeshTopology

This setting controls the level of output for mesh topology (elements and nodes) of the source region
in all data transfers.

Type DebugLevel

Read Only No

ExpertSettings
The entity to store advanced options for data mapping.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Settings

The expert setting parameters dictionary.

Type Dictionary<string, string>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 865
System Coupling

Methods
AddProperty

Adds a property to expert settings.

Required Arguments

Property Property to be added.

Type string

GetProperty

Returns the property value for a specified property.

Return The value of the property.

Type string

Required Arguments

Property The name of the property.

Type string

RemoveProperty

Removes an existing property from expert settings.

Required Arguments

Property Property to be removed.

Type string

SetProperty

Sets the value of a property in expert settings.

Required Arguments

Property The name of the property.

Type string

Value The value of the property.

Type string

IntermediateResultFilesOutputControls
The entity to store the settings for result files creation during a coupling run.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
866 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

OutputFrequency

This property specifies the frequency at which the result files are generated.

Type OutputFrequencyType

Read Only No

StepInterval

The step interval at which the result files are generated.

Type int

Read Only No

SequenceControl
The entity to store solver sequence information for a coupling run.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Sequence

Dictionary containing sequence values for each participant.

Type Dictionary<DataReference, int>

Read Only No

Methods
GetSequence

Returns the sequence value for a participant.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 867
System Coupling

Return Sequence value for the given participant.

Type int

Required Arguments

Participant The participant for which to get the sequence.

Type DataReference

SetSequence

This command will set the sequence number for the specified participant.

Required Arguments

Participant The participant for which to set sequence value.

Type DataReference

Value Sequence value for the given participant.

Type int

SystemCouplingCoSimulationParticipant
This is a base class for the entity which represents System Coupling Co-simulation Participant information.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string

Read Only No

SystemCouplingParticipant
This is a base class for the entity which represents System Coupling Participant information. System
Coupling Participant information comprises of System and solver-level information related to coupling.
Note- Coupling participants are systems that will provide and/or consume data in a coupled analysis.
Example systems in Workbench include: Analysis Systems – Steady-State Thermal, Transient Thermal,
Static Structural, Transient Structural, Fluid Flow (Fluent) Component Systems – Fluent, External Data

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
868 of ANSYS, Inc. and its subsidiaries and affiliates.
Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string

Read Only No

SystemCouplingRegion
This entity represents a System Coupling Region. A region is most often a point, line, surface or volume
that is part (or all) of the geometry or topology of a coupling participant.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

InternalName

The name of the region as understood by the solver

Type string

Read Only No

Topology

The topology of the region

Type TopologyType

Read Only No

SystemCouplingStaticDataParticipant
This is a base class/entity for the entity which represents System Coupling Static Data Participant inform-
ation.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 869
System Coupling

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string

Read Only No

SystemCouplingSteadyCoSimulationParticipant
The entity represents System Coupling Steady Co-simulation Participant information e.g. information
related to Static Structural Participant System for coupling purpose.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string

Read Only No

SystemCouplingSteadyStaticDataParticipant
The entity represents System Coupling Steady Static Data Participant information e.g. information related
to External Data Participant System for coupling purposes.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
870 of ANSYS, Inc. and its subsidiaries and affiliates.
Type string

Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string

Read Only No

SystemCouplingTransientCoSimulationParticipant
The entity represents System Coupling Transient Co-simulation Participant information e.g. information
related to Transient Structural Participant System for coupling purposes.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Type string

Read Only No

SystemCouplingTransientStaticDataParticipant
The entity represents System Coupling Transient Static Data Participant information.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

InternalName

The internal name of the multiphysics participant (usually a solver) that is providing this data

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 871
System Coupling

Type string

Read Only No

SystemCouplingVariable
This entity represents a System Coupling Variable. A variable is a physical quantity such as force, length,
or temperature that can be transferred between regions of participant systems.

Properties
DataType

The tensor type of the variable

Type DataTypeEnumeration

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Exposure

The type of transfer that will be done with this variable

Type VariableExposure

Read Only No

InternalName

The name of the variable

Type string

Read Only No

PhysicalType

The quantity type of the variable

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
872 of ANSYS, Inc. and its subsidiaries and affiliates.
System Coupling Solution
This container holds Solution data for an instance of System Coupling.

Methods
CreateConvergenceChart
Creates a new convergence chart.

Return The data reference to the new convergence chart.

Type DataReference

Required Arguments

Name The name for this Convergence Chart.

Type string

CreateSolutionInformation
Creates a new solution information entity and adds it to the specified system coupling solution container.

Return The new solution information that was created.

Type DataReference

Required Arguments

Name The name for this Solution Information.

Type string

SolutionInformationFilePath The path of the file to read solution information.

Type string

GetAllSolutionInformation
Returns the collection of solution information entities in a container. If no solution information entities
are in the container, the collection is empty.

Return Collection of the solution informations in the container.

Type DataReferenceSet

GetChartVariableNames
Returns a dictionary of fully qualified chart variable names and display names.

During System Coupling Solution cell Update or after Solution cell Update, these names can be used
to create chart variable using "CreateVariable" data entity method of "ConvergenceChart".

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 873
System Coupling

Data transfer chart variable

Qualified Name Format - "Target Participant Internal Name":"Data Transfer Internal

Name":"Variable Name": "Operator Name"
Qualfied Name Example- "Solution 1:Data Transfer 1:Change:Maximum"
Display Name Example- "Fluid Flow (FLUENT):Data Transfer 1:Change:Maximum"

Solver chart variable

Qualified Name Format - "Participant Internal Name":"Variable Name"

Qualfied Name Example- "Solution 1:Continuity Convergence"
Display Name Example- "Fluid Flow (FLUENT):Continuity Convergence"

Return A dictionary of fully qualified chart variable names and display names

Please see summary documentation of this (GetChartVariableNames) query on details of

format and example of fully qualified name.

Type Dictionary<string, string>

GetConvergenceChart
Returns the convergence chart of a given name in a container.

Return The convergence chart that matches the specified name.

Type DataReference

Required Arguments

Name The name or display name of the convergence chart.

Type string

GetConvergenceCharts
Returns the collection of convergence charts in a container. If no convergence charts are in the container,
the collection is empty.

Return Collection of the convergence charts in the container.

Type DataReferenceSet

GetSolutionComponentProperties
Returns the solution component properties for a system coupling solution container.

Return Data reference to the properties objects.

Type DataReference

GetSolutionInformation
Returns the solution information of a given name in a container.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
874 of ANSYS, Inc. and its subsidiaries and affiliates.
Return The solution information that matches the specified name.

Type DataReference

Required Arguments

Name The name or display name of the solution information.

Type string

Data Entities
AxisContinuous
A chart axis that spans a set of continuous values. An example is an axis of an XY plot

Properties
AutomaticRange

The property to define whether or not automatic scaling should be applied to the axis, or whether the
RangeMin and RangeMax should be used.

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

QuantityName

The name of the quantity associated with axis data.

E.g. Coupling Iteration, Coupling Step, Coupling Time

Type string

Read Only No

RangeMaximum

The maximum range of the values in this axis.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 875
System Coupling

RangeMinimum

The minimum range of the values in this axis.

Type double

Read Only No

Scale

The scale of the axis. Scale can be defined as Linear/CommonLog (Log base 10)/Natural Log.

Type Scale

Read Only No

Title

The title of the axis.

Type string

Read Only No

ChartVariable
Entity representing a variable in Convergence Chart

Properties
Color

The line color of this chart variable in a plot.

This property is valid only for the chart displayed in Scene View.

Type Color

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

LineWidth

The width of the line drawn for this chart variable in pixels.

This property is valid only for the chart displayed in Scene View.

Type float

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
876 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

QualifiedName

The variable quantity to display.

Type string

Read Only No

RefinementLevel

Refinement level for the data to be plotted.

Type string

Read Only No

SymbolSize

The size of a symbol in pixels when a symbol is drawn for this variable. The rendered symbol size may
be slightly smaller or larger than expected if symbol does not correctly fit into the specified number of
pixels.

This property is valid only for the chart displayed in Scene View.

Type uint

Read Only No

Methods
Delete

Deletes a specified chart variable.

ConvergenceChart
Entity to store a convergence chart information.

Properties
AxisX

Associated X Axis

Type DataReference

Read Only No

AxisY

Associated Y Axis

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 877
System Coupling

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Variables

Collection of variables to be plotted.

Type DataReferenceSet

Read Only No

XAxis

X Axis Quantity Name

Type string

Read Only No

Methods
CreateVariable

Creates a chart variable based on specified quailified name and adds it to the specified convergence
chart.

During System Coupling Solution cell Update or after Solution cell Update, user can create convergence
chart and add chart variables. A chart variable is based on specified fully qualified name. GetChartVari-
ableNames query returns a dictionary of fully qualified chart variable names and display names. This
can be used to create charts.

Data transfer chart variable format

Qualified Name Format - "Target Participant Internal Name":"Data Transfer Internal

Name":"Variable Name": "Operator Name"
Qualfied Name Example- "Solution 1:Data Transfer 1:Change:Maximum"
Display Name Example- "Fluid Flow (FLUENT):Data Transfer 1:Change:Maximum"

Solver chart variable format

Qualified Name Format - "Participant Internal Name":"Variable Name"

Qualfied Name Example- "Solution 1:Continuity Convergence"
Display Name Example- "Fluid Flow (FLUENT):Continuity Convergence"

Return The new created chart variable.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
878 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

QualifiedName The fully qualified name for this chart variable.

Please see summary documentation of this (CreateVariable) data entity method on

details of format and example of fully qualified name.

Type string

Optional Arguments

DisplayName The display name for this chart variable.

Type string

Example
The following example demonstrates creation of chart variables. It is assumed that user has setup partcipants
(e.g. Transient Structural and Fluid Flow(Fluent) and System Coupling system, and also solved coupled
analysis.

# Get System Couplng Solution

system1 = GetSystem(Name="SC")
solution1 = system1.GetContainer(ComponentName="Solution")
# Create Convergence Chart
ConvergenceChart1 = solution1.CreateConvergenceChart(Name="Chart")
# Create a Data Transfer chart variable
ChartVariable1 = ConvergenceChart1.CreateVariable(QualifiedName="Solution 1:Data Transfer 1:Change:Maximum"
# Create a solver chart variable
ChartVariable2 = ConvergenceChart1.CreateVariable(QualifiedName="Solution 1:Continuity Convergence",Display

Delete

Delete's a specified convergence chart.

GetAxis

Returns the axis for a specified convergence chart

Return The axis

Type DataReference

Required Arguments

Name Name of the Axis

Type string

GetChartVariable

Returns the chart variable of a given name from a convergence chart

Return The chart variable that matches the specified name.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 879
System Coupling

Required Arguments

QualifiedName The qualified name of the chart variable.

Type string

GetChartVariables

Returns the collection of chart variables for a given convergence chart

Return A collection of the variables in the chart.

Type DataReferenceSet

SolutionComponentProperties
The entity to store additional command line options which are passed to the coupling service on update.

Properties
CommandLineOptions

Additional command line options which are passed to the coupling service on update.

Type string

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

SolutionInformation
Entity to store the solution information provided by the coupled participants.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

FilePath

The path of the solution information file.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
880 of ANSYS, Inc. and its subsidiaries and affiliates.
Type string

Read Only No

Methods
Delete

Deletes a specified solution information entity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 881
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
882 of ANSYS, Inc. and its subsidiaries and affiliates.
TurboSystems

Turbo Geometry
This container holds Geometry data for an instance of BladeGen.

Methods
CreateBladeMesh
Creates a new Mesh system and automatically meshes the fluid zone for the blade geometry from the
Blade Design component.

CreateGeometry
This command class creates a new BladeEditor model. An up-to-date Geometry cell appears on the
project schematic containing the new model.

Edit
Opens the BladeGen editor to allow modification of Blade Design data.

This command will open the editor only if one is not already open on this component. If this component's
editor is already open, then it will be raised to the front.

Exit
Exits the BladeGen editor.

Any changes made in this editor will be retained on exit. These changes are made permanent by a
Project Save, and will be discarded in the event of closing the project without saving. If no editor is
open on the component in question, this command will have no effect.

Optional Arguments

ExitApp This parameter is deprecated and will be ignored.

Type bool

Default Value True

GetTurboGeometryProperties
Returns the Data Entity which contains user settings and properties for the Blade Design container.

Return A reference to the requested data entity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 883
TurboSystems

Type DataReference

Import
Imports blade geometry data into the BladeGen editor from an existing BladeGen file.

Required Arguments

FilePath Command argument containing the file name to be opened.

Type string

Example

template1 = GetTemplate(TemplateName="BladeGen")
system1 = template1.CreateSystem()
bladeDesign1 = system1.GetContainer(ComponentName="Blade Design")
bladeDesign1.Import(FilePath="myfilepath/pump.bgd")

Data Entities
TurboGeometryProperties
This data entity provides access to the import properties that are used to determine how the blade
geometry is handled when it is transferred to a downstream Geometry cell.

Properties
BladeExt

Import Option that specifies the blade surface extension length (as a percentage of the average hub
to shroud distance) when the Blade Design data is transferred to a downstream Geometry. These surfaces
are extended and then trimmed to the MasterProfile sketch to ensure that the blade solid correctly
matches the hub and shroud contours.

Type double

Read Only No

BladeLoftOption

Import Option that specifies how to loft the blade surfaces when the Blade Design data is transferred
to a downstream Geometry.

Available options:

Streamwise Loft the blade surfaces in the streamwise dir-

ection through curves that run from hub to
shroud.
Spanwise Loft the blade surfaces in the spanwise direc-
tion through the blade profile curves.

Type BladeLoftType

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
884 of ANSYS, Inc. and its subsidiaries and affiliates.
CreateAllBlades

Import Option that specifies whether to create one or all blades when the Blade Design data is transferred
to a downstream Geometry.

Available options:

True BladeEditor will create all the blades using the

number of blades specified in the BladeGen
model.
False Only one blade will be created.

Type bool

Read Only No

CreateFluidZone

Import Option that specifies whether to create the fluid zone body when the Blade Design data is
transferred to a downstream Geometry. The resulting Enclosure can be used for a CFD analysis of the
blade passage.

Available options:

True Create the fluid zone Enclosure.

False Don't create the fluid zone Enclosure.

Type bool

Read Only No

CreateHub

Import Option that specifies whether a hub body will be created when the Blade Design data is trans-
ferred to a downstream Geometry.

Available options:

True BladeEditor will create a HubProfile sketch for

the non-flow path hub geometry, and will
create a revolved body feature called Hub-
Body.
False BladeEditor will not create the hub body.

Type bool

Read Only No

CreateNamedSelections

Import Option that specifies whether to create the Named Selections for the fluid zone when the Blade
Design data is transferred to a downstream Geometry. If this property is selected, then BladeEditor will
create Named Selections (regions) for the typical faces of the blade passage, i.e., Blade, Hub, Shroud,
Inflow, Outflow, PeriodicA and PeriodicB. These Named Selections can be used as selection groups in

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 885
TurboSystems

other ANSYS Workbench applications. Note that this property is available only if Create Fluid Zone is
selected.

Available options:

True Create the Named Selections.

False Don't create the Named Selections.

Type bool

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

LayerNumber

Import Option that specifies the integer value of the Layer Number to use for the shroud clearance
when the Blade Design data is transferred to a downstream Geometry. This property only applies when
the Shroud Clearance property is set to Relative Layer or Absolute Layer.

Type int

Read Only No

MachineType

Specification of the machine type, used by the downstream VistaTF setup

Available options:

Pump
AxialCompressor
CentrifugalCompressor
Fan
AxialTurbine
RadialTurbine
HydraulicTurbine
Other
Unknown

Type MachineType

Read Only No

MergeBladeTopology

Import Option that specifies whether to merge the blade faces when the Blade Design data is transferred
to a downstream Geometry. If not merged, there will be four faces corresponding to the leading edge,

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
886 of ANSYS, Inc. and its subsidiaries and affiliates.
trailing edge, pressure and suction surfaces of the blade. If merged, blade faces that are tangent to one
another will be merged into a single face.

Available options:

True Merge the blade faces where they are tangent

to one another.
False Don't merge the blade faces.

Type bool

Read Only No

ModelUnits

THIS PROPERTY IS DEPRECATED IN WB16.0 AND IS RETAINED PURELY FOR BACKWARDS COMPATIBILITY.

The length scale units the BladeGen model was created in. Used when transfering the BladeGen model
to VistaTF.

Available options:

m
cm
mm
inches
ft

Type BMunitsType

Read Only No

PeriodicSurfExt

Import Option that defines the periodic surface extension length (as a percentage of the average hub
to shroud distance) when the Blade Design data is transferred to a downstream Geometry.

Type double

Read Only No

PeriodicSurfOption

Import Option that specifies the style of the periodic interface surfaces for the fluid zone when the
Blade Design data is transferred to a downstream Geometry. Note that this property is available only if
Create Fluid Zone is selected.

Available options:

OnePiece The periodic surface is created as a single

surface.
ThreePieces The periodic surface is created in three con-
nected pieces: one upstream of the blade, one
within the passage, and one downstream of
the blade. This style can better accommodate

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 887
TurboSystems

highly curved or twisted blades, and is similar

to the ANSYS TurboGrid style of periodic sur-
face.

Type PeriodicSurfType

Read Only No

ShroudClearance

Import Option that specifies whether to include the shroud clearance when the Blade Design data is
transferred to a downstream Geometry.

Available options:

None No shroud clearance is created.

RelativeLayer The selected Layer Number is relative to the
shroud layer, e.g., 1 implies the first layer
closest to the shroud layer, 2 implies the
second closest layer to the shroud, etc.
AbsoluteLayer The selected layer index counts up from the
hub layer, which is zero.

Type ClearanceType

Read Only No

SpanwiseCount

The number of spanwise gridlines used in the downstream VistaTF calculation. Default = 4

Type int

Read Only No

StreamwiseCount

The number of streamwise gridlines used in the downstream VistaTF calculation. Default = 20

Type int

Read Only No

Turbo Mesh
This container holds Mesh data for an instance of TurboGrid.

Methods
Edit
Opens the TurboGrid editor to allow modification of Turbo Mesh data.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
888 of ANSYS, Inc. and its subsidiaries and affiliates.
Optional Arguments

Interactive Run the editor in interactive mode if True, or in no GUI mode if False.

If not specified, the editor runs in interactive mode.

Type bool

Default Value True

TopologySuspended If True, open the editor with the topology in a suspended state. Otherwise, open
the editor with the suspended state of topology the same as when the editor was
last closed.

If not specified, it defaults to false.

Type bool

Default Value False

Exit
Exits the editor.

Any changes made in this editor will be retained on exit. These changes are made permanent by a
Project Save, and will be discarded in the event of closing the project without saving.

If no editor is open on the component in question, this command will have no effect.

GetTurboMeshProperties
Returns the Data Entity which contains user settings and properties for the Turbo Mesh container.

Return A reference to the requested data entity.

Type DataReference

LoadBladeGen
This command imports the specified BladeGen INF file data into the Turbo Mesh cell. If an upstream
geometry link to the Turbo Mesh cell exists an error message is generated.

template1 = GetTemplate(TemplateName="TurboGrid")
system1 = template1.CreateSystem()
turboMesh1 = system1.GetContainer(ComponentName="Turbo Mesh")
turboMesh1.LoadBladeGen(FileName="myfilepath/BladeGen.inf")

Required Arguments

FileName Name, and path, of the BladeGen INF file to be imported.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 889
TurboSystems

ReinitializeContainer
This command reinitialises the selected container, resetting the local data and using the cached initial-
isation CCL commands

SendCommand
Sends commands to the editor for this component using CFX Command Language (CCL) syntax. If the
editor for this component is not open, it will be launched before the commands are sent and sub-
sequently closed. In this mode, component data is loaded and saved as if calling Edit(Interactive=False)
and Exit around the SendCommand invocation.

The instructions must be CFX Command Language session commands that are valid for the editor in
question.

Required Arguments

Com- Valid CFX Command Language (CCL) commands

mand
Type string

SetInitCCL
Sets the initialisation commands for this component using CFX Command Language (CCL) syntax. On
setting the commands they may be applied to the editor in question using ApplyInitCCLCommand.

The instructions must be CFX Command Language session commands that are valid for the editor in
question.

Required Arguments

Com- Valid CFX Command Language (CCL) commands

mand
Type string

Data Entities
TurboMeshProperties
This data entity provides access to the properties that are used to determine which blade geometry to
mesh and how to handle the inlet and outlet positions.

Properties
AvailableFlowpaths

Displays a list of the available flowpaths and bladerows. Use this information as a guide when specifying
the Flowpath and Bladerow properties (described below). Use the Refresh command in the context
menu to update the list after linking.

Type string

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
890 of ANSYS, Inc. and its subsidiaries and affiliates.
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

DownstreamBladerowNumber

Specifies the bladerow number for the bladerow that is immediately downstream of the current bladerow.
This property is available only when Outlet Position Method is set to Adjacent Blade.

Type int

Read Only No

InletBlock

If this is checked then an inlet block will be generated, if possible, when the mesh is created.

Type bool

Read Only No

InletPositionOption

Specifies how the inlet points are positioned in TurboGrid. This property is only available when multiple
bladerows in the same flowpath have been exported from BladeEditor.

Available options:

Manual The user will specify the inlet points in Tur-

boGrid.
AdjacentBlade TurboGrid will calculate the inlet points to be
halfway between the selected upstream
bladerow and the current bladerow.

Type OpeningPositionMethod

Read Only No

MaximumFaceAngle

This is the maximum face angle in the mesh if the mesh has been generated.

Type Quantity

Read Only No

MeshNamePrefix

If specified, this string will be prepended to all region names in the mesh when transferred to a CFX
system. This option is only available when Beta features are enabled.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 891
TurboSystems

Type string

Read Only No

MinimumFaceAngle

This is the minimum face angle in the mesh if the mesh has been generated.

Type Quantity

Read Only No

OutletBlock

If this is checked then an outlet block will be generated, if possible, when the mesh is created.

Type bool

Read Only No

OutletPositionOption

Specifies how the outlet points are positioned in TurboGrid. This property is only available when multiple
bladerows in the same flowpath have been exported from BladeEditor.

Available options:

Manual The user will specify the outlet points in Tur-

boGrid.
AdjacentBlade TurboGrid will calculate the outlet points to
be halfway between the selected downstream
bladerow and the current bladerow.

Type OpeningPositionMethod

Read Only No

SelectedBladerowNum

Specifies which bladerow (within the specified Flowpath feature) is to be loaded in ANSYS TurboGrid.
The bladerows are number sequentially, starting from 1 for native Blade features.

Type int

Read Only No

SelectedFlowpathName

Specifies which Flowpath feature in BladeEditor contains the bladerow that is to be loaded in ANSYS
TurboGrid. On initial refresh, it will default to the first flowpath available.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
892 of ANSYS, Inc. and its subsidiaries and affiliates.
UpstreamBladerowNumber

Specifies the bladerow number for the bladerow that is immediately upstream of the current bladerow.
This property is available only when Inlet Position Method is set to Adjacent Blade.

Type int

Read Only No

Turbo Setup
This container holds data for an instance of Turbo Setup.

Methods
CreatePerformanceMap
This command class creates new Turbo Fluid Flow and Microsoft Excel systems. The new systems appear
on the project schematic. Appropriate parameters are exposed from the systems and linked. Design
points are then created from the speedlines data in the Turbo Setup.

CreateThroughflow
This command class creates a new VistaTF system. The system, comprising Setup, Solution and Results
cells, is created on the project schematic and the operating conditions set accordingly.

Return Container representing the VistaTF Setup cell.

Type DataContainerReference

CreateTurboflow
This command class creates a new Turbomachinery Fluid Flow system. The new system appears on the
project schematic containing Turbo Mesh, Setup, Solution and Results cells. The Turbo Mesh and Setup
cells are initialised leaving the system ready to update.

Return Data reference to the Turbo Fluid Flow system.

Type DataReference

Edit
This command class launches the Turbo Setup popup GUI.

GetTurboSetupProperties
Returns the Data Entity which contains user settings and properties for the Turbo Setup container.

Return Reference to the requested Data Entity

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 893
TurboSystems

Data Entities
TurboSetupProperties
This data entity provides access to the properties which define the Turbo Setup component.

Properties
Acentric

This property specifies the acentric factor for the working fluid. Note that this is only available when
MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type float

Read Only No

Alpha3

This property specifies the flow angle at the inlet to the machine in the absolute reference frame.

Type Quantity

Read Only No

ComponentConfig

This property specifies the configuration of the components which the machine is comprised of.

Available options:

Impeller and Vaneless Diffuser

Type ComponentConfigType

Read Only No

Cp_A0

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the constant component (coefficient of T^0) of
the lower temperature range polynomial. Note that this is only available when MaterialPropsOption is
set to 'User' and the GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_A1

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^1 of the lower temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
894 of ANSYS, Inc. and its subsidiaries and affiliates.
Type double

Read Only No

Cp_A2

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^2 of the lower temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_A3

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^3 of the lower temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_A4

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^4 of the lower temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_Amax

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the maximum temperature limit for which the
lower temperature range polynomial is applicable. Note that this is only available when MaterialProp-
sOption is set to 'User' and the GasModelOption is set to 'Real'.

Type float

Read Only No

Cp_Amin

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the minimum temperature limit for which the
lower temperature range polynomial is applicable. Note that this is only available when MaterialProp-
sOption is set to 'User' and the GasModelOption is set to 'Real'.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 895
TurboSystems

Type float

Read Only No

CriticalPressure

This property specifies the critical pressure for the working fluid. Note that this is only available when
MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type Quantity

Read Only No

CriticalTemp

This property specifies the critical temperature for the working fluid. Note that this is only available
when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type Quantity

Read Only No

CriticalVol

This property specifies the critical volume for the working fluid. Note that this is only available when
MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type Quantity

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

GammaUser

This property specifies the ratio of specific heats for the working fluid. Note that this is only available
when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Ideal'.

Type float

Read Only No

GasModel

This property specifies whether to treat the working fluid as an Ideal or a Real gas.

Available options:

Ideal

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
896 of ANSYS, Inc. and its subsidiaries and affiliates.
 Real

Type GasModelType

Read Only No

InputMethod1

This property specifies the input method used to set the mass flow rates for the speedline. The 'Range'
option indicates that the flow rates will be evenly distributed between the min and max flowrates. Al-
ternatively the 'Direct' option can be used to specify the values directly.

Available options:

Range
Direct

Type SpeedInputType

Read Only No

InputMethod10

This property specifies the input method used to set the mass flow rates for the speedline. The 'Range'
option indicates that the flow rates will be evenly distributed between the min and max flowrates. Al-
ternatively the 'Direct' option can be used to specify the values directly.

Available options:

Range
Direct

Type SpeedInputType

Read Only No

InputMethod2

This property specifies the input method used to set the mass flow rates for the speedline. The 'Range'
option indicates that the flow rates will be evenly distributed between the min and max flowrates. Al-
ternatively the 'Direct' option can be used to specify the values directly.

Available options:

Range
Direct

Type SpeedInputType

Read Only No

InputMethod3

This property specifies the input method used to set the mass flow rates for the speedline. The 'Range'
option indicates that the flow rates will be evenly distributed between the min and max flowrates. Al-
ternatively the 'Direct' option can be used to specify the values directly.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 897
TurboSystems

Available options:

Range
Direct

Type SpeedInputType

Read Only No

InputMethod4

This property specifies the input method used to set the mass flow rates for the speedline. The 'Range'
option indicates that the flow rates will be evenly distributed between the min and max flowrates. Al-
ternatively the 'Direct' option can be used to specify the values directly.

Available options:

Range
Direct

Type SpeedInputType

Read Only No

InputMethod5

This property specifies the input method used to set the mass flow rates for the speedline. The 'Range'
option indicates that the flow rates will be evenly distributed between the min and max flowrates. Al-
ternatively the 'Direct' option can be used to specify the values directly.

Available options:

Range
Direct

Type SpeedInputType

Read Only No

InputMethod6

This property specifies the input method used to set the mass flow rates for the speedline. The 'Range'
option indicates that the flow rates will be evenly distributed between the min and max flowrates. Al-
ternatively the 'Direct' option can be used to specify the values directly.

Available options:

Range
Direct

Type SpeedInputType

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
898 of ANSYS, Inc. and its subsidiaries and affiliates.
InputMethod7

This property specifies the input method used to set the mass flow rates for the speedline. The 'Range'
option indicates that the flow rates will be evenly distributed between the min and max flowrates. Al-
ternatively the 'Direct' option can be used to specify the values directly.

Available options:

Range
Direct

Type SpeedInputType

Read Only No

InputMethod8

This property specifies the input method used to set the mass flow rates for the speedline. The 'Range'
option indicates that the flow rates will be evenly distributed between the min and max flowrates. Al-
ternatively the 'Direct' option can be used to specify the values directly.

Available options:

Range
Direct

Type SpeedInputType

Read Only No

InputMethod9

This property specifies the input method used to set the mass flow rates for the speedline. The 'Range'
option indicates that the flow rates will be evenly distributed between the min and max flowrates. Al-
ternatively the 'Direct' option can be used to specify the values directly.

Available options:

Range
Direct

Type SpeedInputType

Read Only No

MassFlow

This property specifies the design point mass flow rate passing through the machine.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 899
TurboSystems

MaterialNameSelection

This property specifies the name of the working fluid, as selected from the database. Note that this is
only available when the MaterialPropsOption is set to 'Database'.

Available options:

air
carbon_dioxide
hydrogen
methane
nitrogen
oxygen
parahydrogen
propylene
R123
R125
R134a
R141b
R142b
R245fa
water

Type MaterialNamesList

Read Only No

MaterialPropsOption

This property specifies whether the working fluid properties are chosen from the materials database or
specified directly by the user.

Available options:

Database
User

Type MaterialPropsType

Read Only No

MaxFlow1

Maximum flow rate on speedline 1.

Type Quantity

Read Only No

MaxFlow10

Maximum flow rate on speedline 10.

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
900 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

MaxFlow2

Maximum flow rate on speedline 2.

Type Quantity

Read Only No

MaxFlow3

Maximum flow rate on speedline 3.

Type Quantity

Read Only No

MaxFlow4

Maximum flow rate on speedline 4.

Type Quantity

Read Only No

MaxFlow5

Maximum flow rate on speedline 5.

Type Quantity

Read Only No

MaxFlow6

Maximum flow rate on speedline 6.

Type Quantity

Read Only No

MaxFlow7

Maximum flow rate on speedline 7.

Type Quantity

Read Only No

MaxFlow8

Maximum flow rate on speedline 8.

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 901
TurboSystems

Read Only No

MaxFlow9

Maximum flow rate on speedline 9.

Type Quantity

Read Only No

MeshNodeCount

This property specifies the target passage node count used with the ATM meshing scheme in TurboGrid
The minimum value for this property is 50,000 nodes

Type int

Read Only No

MinFlow1

Minimum flow rate on speedline 1.

Type Quantity

Read Only No

MinFlow10

Minimum flow rate on speedline 10.

Type Quantity

Read Only No

MinFlow2

Minimum flow rate on speedline 2.

Type Quantity

Read Only No

MinFlow3

Minimum flow rate on speedline 3.

Type Quantity

Read Only No

MinFlow4

Minimum flow rate on speedline 4.

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
902 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

MinFlow5

Minimum flow rate on speedline 5.

Type Quantity

Read Only No

MinFlow6

Minimum flow rate on speedline 6.

Type Quantity

Read Only No

MinFlow7

Minimum flow rate on speedline 7.

Type Quantity

Read Only No

MinFlow8

Minimum flow rate on speedline 8.

Type Quantity

Read Only No

MinFlow9

Minimum flow rate on speedline 9.

Type Quantity

Read Only No

MuUser

This property specifies the dynamic viscosity of the working fluid.

Type Quantity

Read Only No

NFlow1

The number of mass flow rates specified on speedline 1.

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 903
TurboSystems

Read Only No

NFlow10

The number of mass flow rates specified on speedline 10.

Type int

Read Only No

NFlow2

The number of mass flow rates specified on speedline 2.

Type int

Read Only No

NFlow3

The number of mass flow rates specified on speedline 3.

Type int

Read Only No

NFlow4

The number of mass flow rates specified on speedline 4.

Type int

Read Only No

NFlow5

The number of mass flow rates specified on speedline 5.

Type int

Read Only No

NFlow6

The number of mass flow rates specified on speedline 6.

Type int

Read Only No

NFlow7

The number of mass flow rates specified on speedline 7.

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
904 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

NFlow8

The number of mass flow rates specified on speedline 8.

Type int

Read Only No

NFlow9

The number of mass flow rates specified on speedline 9.

Type int

Read Only No

NSpeeds

The number of speedlines to be calculated by the Turbo Fluid Flow system.

Type int

Read Only No

Omega

This property specifies the design point rotational speed of the impeller.

Type Quantity

Read Only No

Omega1

The percentage rotational speed of the impeller for speedline 1.

Type int

Read Only No

Omega10

The percentage rotational speed of the impeller for speedline 10.

Type int

Read Only No

Omega2

The percentage rotational speed of the impeller for speedline 2.

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 905
TurboSystems

Read Only No

Omega3

The percentage rotational speed of the impeller for speedline 3.

Type int

Read Only No

Omega4

The percentage rotational speed of the impeller for speedline 4.

Type int

Read Only No

Omega5

The percentage rotational speed of the impeller for speedline 5.

Type int

Read Only No

Omega6

The percentage rotational speed of the impeller for speedline 6.

Type int

Read Only No

Omega7

The percentage rotational speed of the impeller for speedline 7.

Type int

Read Only No

Omega8

The percentage rotational speed of the impeller for speedline 8.

Type int

Read Only No

Omega9

The percentage rotational speed of the impeller for speedline 9.

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
906 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

Preswirl

This property specifies how the radial distribution of the preswirl angle is calculated.

Available options:

constant
free
forced
linear

Type PreswirlType

Read Only No

RotationalDirection

Specifies the positive direction of machine rotation about the Z-axis.

Available options:

RightHanded Positive rotation is clockwise about the Z-axis.

LeftHanded Positive rotation is counterclockwise about
the Z-axis.

Type RotationType

Read Only No

RUser

This property specifies the specific gas constant for the working fluid. Note that this is only available
when MaterialPropsOption is set to 'User'.

Type Quantity

Read Only No

Speed10MassFlow1

Mass flow rate 1 on speedline 10.

Type Quantity

Read Only No

Speed10MassFlow10

Mass flow rate 10 on speedline 10.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 907
TurboSystems

Speed10MassFlow2

Mass flow rate 2 on speedline 10.

Type Quantity

Read Only No

Speed10MassFlow3

Mass flow rate 3 on speedline 10.

Type Quantity

Read Only No

Speed10MassFlow4

Mass flow rate 4 on speedline 10.

Type Quantity

Read Only No

Speed10MassFlow5

Mass flow rate 5 on speedline 10.

Type Quantity

Read Only No

Speed10MassFlow6

Mass flow rate 6 on speedline 10.

Type Quantity

Read Only No

Speed10MassFlow7

Mass flow rate 7 on speedline 10.

Type Quantity

Read Only No

Speed10MassFlow8

Mass flow rate 8 on speedline 10.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
908 of ANSYS, Inc. and its subsidiaries and affiliates.
Speed10MassFlow9

Mass flow rate 9 on speedline 10.

Type Quantity

Read Only No

Speed1MassFlow1

Mass flow rate 1 on speedline 1.

Type Quantity

Read Only No

Speed1MassFlow10

Mass flow rate 10 on speedline 1.

Type Quantity

Read Only No

Speed1MassFlow2

Mass flow rate 2 on speedline 1.

Type Quantity

Read Only No

Speed1MassFlow3

Mass flow rate 3 on speedline 1.

Type Quantity

Read Only No

Speed1MassFlow4

Mass flow rate 4 on speedline 1.

Type Quantity

Read Only No

Speed1MassFlow5

Mass flow rate 5 on speedline 1.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 909
TurboSystems

Speed1MassFlow6

Mass flow rate 6 on speedline 1.

Type Quantity

Read Only No

Speed1MassFlow7

Mass flow rate 7 on speedline 1.

Type Quantity

Read Only No

Speed1MassFlow8

Mass flow rate 8 on speedline 1.

Type Quantity

Read Only No

Speed1MassFlow9

Mass flow rate 9 on speedline 1.

Type Quantity

Read Only No

Speed2MassFlow1

Mass flow rate 1 on speedline 2.

Type Quantity

Read Only No

Speed2MassFlow10

Mass flow rate 10 on speedline 2.

Type Quantity

Read Only No

Speed2MassFlow2

Mass flow rate 2 on speedline 2.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
910 of ANSYS, Inc. and its subsidiaries and affiliates.
Speed2MassFlow3

Mass flow rate 3 on speedline 2.

Type Quantity

Read Only No

Speed2MassFlow4

Mass flow rate 4 on speedline 2.

Type Quantity

Read Only No

Speed2MassFlow5

Mass flow rate 5 on speedline 2.

Type Quantity

Read Only No

Speed2MassFlow6

Mass flow rate 6 on speedline 2.

Type Quantity

Read Only No

Speed2MassFlow7

Mass flow rate 7 on speedline 2.

Type Quantity

Read Only No

Speed2MassFlow8

Mass flow rate 8 on speedline 2.

Type Quantity

Read Only No

Speed2MassFlow9

Mass flow rate 9 on speedline 2.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 911
TurboSystems

Speed3MassFlow1

Mass flow rate 1 on speedline 3.

Type Quantity

Read Only No

Speed3MassFlow10

Mass flow rate 10 on speedline 3.

Type Quantity

Read Only No

Speed3MassFlow2

Mass flow rate 2 on speedline 3.

Type Quantity

Read Only No

Speed3MassFlow3

Mass flow rate 3 on speedline 3.

Type Quantity

Read Only No

Speed3MassFlow4

Mass flow rate 4 on speedline 3.

Type Quantity

Read Only No

Speed3MassFlow5

Mass flow rate 5 on speedline 3.

Type Quantity

Read Only No

Speed3MassFlow6

Mass flow rate 6 on speedline 3.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
912 of ANSYS, Inc. and its subsidiaries and affiliates.
Speed3MassFlow7

Mass flow rate 7 on speedline 3.

Type Quantity

Read Only No

Speed3MassFlow8

Mass flow rate 8 on speedline 3.

Type Quantity

Read Only No

Speed3MassFlow9

Mass flow rate 9 on speedline 3.

Type Quantity

Read Only No

Speed4MassFlow1

Mass flow rate 1 on speedline 4.

Type Quantity

Read Only No

Speed4MassFlow10

Mass flow rate 10 on speedline 4.

Type Quantity

Read Only No

Speed4MassFlow2

Mass flow rate 2 on speedline 4.

Type Quantity

Read Only No

Speed4MassFlow3

Mass flow rate 3 on speedline 4.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 913
TurboSystems

Speed4MassFlow4

Mass flow rate 4 on speedline 4.

Type Quantity

Read Only No

Speed4MassFlow5

Mass flow rate 5 on speedline 4.

Type Quantity

Read Only No

Speed4MassFlow6

Mass flow rate 6 on speedline 4.

Type Quantity

Read Only No

Speed4MassFlow7

Mass flow rate 7 on speedline 4.

Type Quantity

Read Only No

Speed4MassFlow8

Mass flow rate 8 on speedline 4.

Type Quantity

Read Only No

Speed4MassFlow9

Mass flow rate 9 on speedline 4.

Type Quantity

Read Only No

Speed5MassFlow1

Mass flow rate 1 on speedline 5.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
914 of ANSYS, Inc. and its subsidiaries and affiliates.
Speed5MassFlow10

Mass flow rate 10 on speedline 5.

Type Quantity

Read Only No

Speed5MassFlow2

Mass flow rate 2 on speedline 5.

Type Quantity

Read Only No

Speed5MassFlow3

Mass flow rate 3 on speedline 5.

Type Quantity

Read Only No

Speed5MassFlow4

Mass flow rate 4 on speedline 5.

Type Quantity

Read Only No

Speed5MassFlow5

Mass flow rate 5 on speedline 5.

Type Quantity

Read Only No

Speed5MassFlow6

Mass flow rate 6 on speedline 5.

Type Quantity

Read Only No

Speed5MassFlow7

Mass flow rate 7 on speedline 5.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 915
TurboSystems

Speed5MassFlow8

Mass flow rate 8 on speedline 5.

Type Quantity

Read Only No

Speed5MassFlow9

Mass flow rate 9 on speedline 5.

Type Quantity

Read Only No

Speed6MassFlow1

Mass flow rate 1 on speedline 6.

Type Quantity

Read Only No

Speed6MassFlow10

Mass flow rate 10 on speedline 6.

Type Quantity

Read Only No

Speed6MassFlow2

Mass flow rate 2 on speedline 6.

Type Quantity

Read Only No

Speed6MassFlow3

Mass flow rate 3 on speedline 6.

Type Quantity

Read Only No

Speed6MassFlow4

Mass flow rate 4 on speedline 6.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
916 of ANSYS, Inc. and its subsidiaries and affiliates.
Speed6MassFlow5

Mass flow rate 5 on speedline 6.

Type Quantity

Read Only No

Speed6MassFlow6

Mass flow rate 6 on speedline 6.

Type Quantity

Read Only No

Speed6MassFlow7

Mass flow rate 7 on speedline 6.

Type Quantity

Read Only No

Speed6MassFlow8

Mass flow rate 8 on speedline 6.

Type Quantity

Read Only No

Speed6MassFlow9

Mass flow rate 9 on speedline 6.

Type Quantity

Read Only No

Speed7MassFlow1

Mass flow rate 1 on speedline 7.

Type Quantity

Read Only No

Speed7MassFlow10

Mass flow rate 10 on speedline 7.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 917
TurboSystems

Speed7MassFlow2

Mass flow rate 2 on speedline 7.

Type Quantity

Read Only No

Speed7MassFlow3

Mass flow rate 3 on speedline 7.

Type Quantity

Read Only No

Speed7MassFlow4

Mass flow rate 4 on speedline 7.

Type Quantity

Read Only No

Speed7MassFlow5

Mass flow rate 5 on speedline 7.

Type Quantity

Read Only No

Speed7MassFlow6

Mass flow rate 6 on speedline 7.

Type Quantity

Read Only No

Speed7MassFlow7

Mass flow rate 7 on speedline 7.

Type Quantity

Read Only No

Speed7MassFlow8

Mass flow rate 8 on speedline 7.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
918 of ANSYS, Inc. and its subsidiaries and affiliates.
Speed7MassFlow9

Mass flow rate 9 on speedline 7.

Type Quantity

Read Only No

Speed8MassFlow1

Mass flow rate 1 on speedline 8.

Type Quantity

Read Only No

Speed8MassFlow10

Mass flow rate 10 on speedline 8.

Type Quantity

Read Only No

Speed8MassFlow2

Mass flow rate 2 on speedline 8.

Type Quantity

Read Only No

Speed8MassFlow3

Mass flow rate 3 on speedline 8.

Type Quantity

Read Only No

Speed8MassFlow4

Mass flow rate 4 on speedline 8.

Type Quantity

Read Only No

Speed8MassFlow5

Mass flow rate 5 on speedline 8.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 919
TurboSystems

Speed8MassFlow6

Mass flow rate 6 on speedline 8.

Type Quantity

Read Only No

Speed8MassFlow7

Mass flow rate 7 on speedline 8.

Type Quantity

Read Only No

Speed8MassFlow8

Mass flow rate 8 on speedline 8.

Type Quantity

Read Only No

Speed8MassFlow9

Mass flow rate 9 on speedline 8.

Type Quantity

Read Only No

Speed9MassFlow1

Mass flow rate 1 on speedline 9.

Type Quantity

Read Only No

Speed9MassFlow10

Mass flow rate 10 on speedline 9.

Type Quantity

Read Only No

Speed9MassFlow2

Mass flow rate 2 on speedline 9.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
920 of ANSYS, Inc. and its subsidiaries and affiliates.
Speed9MassFlow3

Mass flow rate 3 on speedline 9.

Type Quantity

Read Only No

Speed9MassFlow4

Mass flow rate 4 on speedline 9.

Type Quantity

Read Only No

Speed9MassFlow5

Mass flow rate 5 on speedline 9.

Type Quantity

Read Only No

Speed9MassFlow6

Mass flow rate 6 on speedline 9.

Type Quantity

Read Only No

Speed9MassFlow7

Mass flow rate 7 on speedline 9.

Type Quantity

Read Only No

Speed9MassFlow8

Mass flow rate 8 on speedline 9.

Type Quantity

Read Only No

Speed9MassFlow9

Mass flow rate 9 on speedline 9.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 921
TurboSystems

StagPressure

This property specifies the design point stagnation pressure, P01, at the inlet to the machine.

Type Quantity

Read Only No

StagTemp

This property specifies the design point stagnation temperature, T01, at the inlet to the machine.

Type Quantity

Read Only No

Vista AFD Analysis

This container holds Analysis data for an instance of Vista AFD.

Methods
CreateBladeDesign
This command class creates a new BladeGen model. An up-to-date BladeGen cell appears on the project
schematic containing the new model.

Return Container representing the BladeGen cell.

Type DataContainerReference

CreateGeometry
This command class creates a new BladeEditor model. An up-to-date Geometry cell appears on the
project schematic containing the new model.

Return Container representing the Geometry cell.

Type DataContainerReference

Edit
This command class launches the Vista popup GUI.

GetVistaAFDAnalysisProperties
This query takes a container reference and returns the Data Entity which contains user settings and
properties for the VistaAFD Analysis container.

Return Reference to the requested Data Entity

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
922 of ANSYS, Inc. and its subsidiaries and affiliates.
Data Entities
VistaAFDAnalysis
Analysis represents a VistaAFD throughflow calculation used to analyse the design performance

Properties
Alpha1

User input, IGV exit angle

Type Quantity

Read Only No

Alpha3

User input, OGV exit angle

Type Quantity

Read Only No

AlphaOGVHub

OGV hub gas exit angle

Type Quantity

Read Only No

AlphaOGVMean

OGV mean gas exit angle

Type Quantity

Read Only No

AlphaRotHub

Rotor hub gas exit angle

Type Quantity

Read Only No

AlphaRotMean

Rotor mean gas exit angle

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 923
TurboSystems

Blade

Blade number to export to Bladegen (0=IGV, 1=Rotor, 2=OGV)

Type int

Read Only No

BladeBetaExit

Blade exit angles

Type List<List<float>>

Read Only No

BladeBetaInlet

Blade inlet angles

Type List<List<float>>

Read Only No

BladeOption

Blade option for export to BladeGen

Type BladeType

Read Only No

BMunits

BladeGen/BladeEditor units

Type string

Read Only No

BMunitsOption

BladeGen/BladeEditor units option

Type BMunitsType

Read Only No

DeHallerOGVHub

OGV hub DeHaller number

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
924 of ANSYS, Inc. and its subsidiaries and affiliates.
DeHallerOGVMean

OGV mean DeHaller number

Type float

Read Only No

DeHallerRotHub

Rotor hub DeHaller number

Type float

Read Only No

DeHallerRotMean

Rotor mean DeHaller number

Type float

Read Only No

DevIGVHub

IGV hub deviation

Type Quantity

Read Only No

DevIGVMean

IGV mean deviation

Type Quantity

Read Only No

DevOGVHub

OGV hub deviation

Type Quantity

Read Only No

DevOGVMean

OGV mean deviation

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 925
TurboSystems

DevRotHub

Rotor hub deviation

Type Quantity

Read Only No

DevRotMean

Rotor mean deviation

Type Quantity

Read Only No

DfOGVHub

OGV hub diffusion factor

Type float

Read Only No

DfOGVMean

OGV mean diffusion factor

Type float

Read Only No

DfRotHub

Rotor hub diffusion factor

Type float

Read Only No

DfRotMean

Rotor mean diffusion factor

Type float

Read Only No

Diameter

User input, outer diameter

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
926 of ANSYS, Inc. and its subsidiaries and affiliates.
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Eta

Aerodynamic efficiency

Type float

Read Only No

EtaInput

User input, efficiency estimate

Type float

Read Only No

EtaTS

System efficiency (t-s)

Type float

Read Only No

EtaTSPipe

Downstream system efficiency (t-s)

Type float

Read Only No

EtaTT

System efficiency (t-t)

Type float

Read Only No

HeadRise

User input, total head rise

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 927
TurboSystems

HtrIn

User input, hub/tip rotor inlet

Type float

Read Only No

HtrOut

User input, hub/tip rotor outlet

Type float

Read Only No

HubLoadParam

User input, hub loading parameter

Type float

Read Only No

HubVelFactor

User input, hub velocity deficit factor

Type float

Read Only No

HubX

Hub annulus X-coords

Type List<Quantity>

Read Only No

HubY

Hub annulus Y-coords

Type List<Quantity>

Read Only No

IGV

User input, IGV option

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
928 of ANSYS, Inc. and its subsidiaries and affiliates.
IGVhubThickX

IGV hub thickness X-coord

Type List<float>

Read Only No

IGVhubThickY

IGV hub thickness Y-coord

Type List<Quantity>

Read Only No

IGVleadingX

IGV leading edge X-coords

Type List<Quantity>

Read Only No

IGVleadingY

IGV leading edge Y-coords

Type List<Quantity>

Read Only No

IGVshrThickX

IGV shroud thickness X-coord

Type List<float>

Read Only No

IGVshrThickY

IGV shroud thickness Y-coord

Type List<Quantity>

Read Only No

IGVthetaLE

IGV leading edge theta

Type List<float>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 929
TurboSystems

IGVtrailingX

IGV trailing edge X-coords

Type List<Quantity>

Read Only No

IGVtrailingY

IGV trailing edge Y-coords

Type List<Quantity>

Read Only No

ImperialUnits

User input, Imperial units option

Type bool

Read Only No

InnerIter

User input, number of inner loop design calculation iterations

Type int

Read Only No

Layer1

Intermediate spanwise layer1 for Export

Type bool

Read Only No

Layer2

Intermediate spanwise layer2 for Export

Type bool

Read Only No

Layer3

Intermediate spanwise layer3 for Export

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
930 of ANSYS, Inc. and its subsidiaries and affiliates.
LoadHub

Rotor hub loading

Type float

Read Only No

LoadMean

Rotor mean loading

Type float

Read Only No

MassFlow

User input, mass flow rate

Type Quantity

Read Only No

MaxLoadHub

Rotor maximum hub loading

Type float

Read Only No

MaxLoadMean

Rotor maximum mean loading

Type float

Read Only No

MixLoss

User input, downstream mixing losses

Type float

Read Only No

NMain

Number of blades in each row

Type List<int>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 931
TurboSystems

OGV

User input, OGV option

Type bool

Read Only No

OGVhubThickX

OGV hub thickness X-coord

Type List<float>

Read Only No

OGVhubThickY

OGV hub thickness Y-coord

Type List<Quantity>

Read Only No

OGVleadingX

OGV leading edge X-coords

Type List<Quantity>

Read Only No

OGVleadingY

OGV leading edge Y-coords

Type List<Quantity>

Read Only No

OGVshrThickX

OGV shroud thickness X-coord

Type List<float>

Read Only No

OGVshrThickY

OGV shroud thickness Y-coord

Type List<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
932 of ANSYS, Inc. and its subsidiaries and affiliates.
OGVthetaLE

OGV leading edge theta

Type List<float>

Read Only No

OGVtrailingX

OGV trailing edge X-coords

Type List<Quantity>

Read Only No

OGVtrailingY

OGV trailing edge Y-coords

Type List<Quantity>

Read Only No

Omega

User input, rotational speed

Type Quantity

Read Only No

OuterIter

User input, number of outer loop design calculation iterations

Type int

Read Only No

Pdyn

Outlet dynamic pressure

Type Quantity

Read Only No

PdynPipe

Downstream dynamic pressure

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 933
TurboSystems

PhiHub

Rotor hub flow coefficient

Type float

Read Only No

PhiMean

Rotor mean flow coefficient

Type float

Read Only No

Power

Power

Type Quantity

Read Only No

RatioIGV

User input, IGV aspect ratio

Type float

Read Only No

RatioOGV

User input, OGV aspect ratio

Type float

Read Only No

RatioRotor

User input, Rotor aspect ratio

Type float

Read Only No

RotorHubThickX

Rotor hub thickness X-coord

Type List<float>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
934 of ANSYS, Inc. and its subsidiaries and affiliates.
RotorHubThickY

Rotor hub thickness Y-coord

Type List<Quantity>

Read Only No

RotorLeadingX

Rotor leading edge X-coords

Type List<Quantity>

Read Only No

RotorLeadingY

Rotor leading edge Y-coords

Type List<Quantity>

Read Only No

RotorShrThickX

Rotor shroud thickness X-coord

Type List<float>

Read Only No

RotorShrThickY

Rotor shroud thickness Y-coord

Type List<Quantity>

Read Only No

RotorThetaLE

Rotor leading edge theta

Type List<float>

Read Only No

RotorTrailingX

Rotor trailing edge X-coords

Type List<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 935
TurboSystems

RotorTrailingY

Rotor trailing edge Y-coords

Type List<Quantity>

Read Only No

Sc90MaxIter

User input, maximum number of solver iterations

Type int

Read Only No

Sc90Relax

User input, solver relaxation factor

Type float

Read Only No

Sc90Tol

User input, solver tolerance

Type float

Read Only No

ShrX

Shroud annulus X-coords

Type List<Quantity>

Read Only No

ShrY

Shroud annulus Y-coords

Type List<Quantity>

Read Only No

SIunits

User input, SI units option

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
936 of ANSYS, Inc. and its subsidiaries and affiliates.
Span

Spanwise fractions

Type List<float>

Read Only No

StagPressure

User input, inlet stagnation pressure

Type Quantity

Read Only No

StagTemp

User input, inlet stagnation temperature

Type Quantity

Read Only No

Torque

Torque

Type Quantity

Read Only No

TrimIGV

User input, IGV profile trim

Type float

Read Only No

TrimOGV

User input, OGV profile trim

Type float

Read Only No

TrimRotor

User input, Rotor profile trim

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 937
TurboSystems

VanesIGV

User input, IGV number of vanes

Type int

Read Only No

VanesOGV

User input, OGV number of vanes

Type int

Read Only No

VanesRotor

User input, Rotor number of vanes

Type int

Read Only No

VistaAFDTitle

Editor Title

Type string

Read Only No

Vista AFD Design

This container holds Design data for an instance of Vista AFD.

Methods
CreateBladeDesign
This command class creates a new BladeGen model. An up-to-date BladeGen cell appears on the project
schematic containing the new model.

Return Container representing the BladeGen cell.

Type DataContainerReference

CreateGeometry
This command class creates a new BladeEditor model. An up-to-date Geometry cell appears on the
project schematic containing the new model.

Return Container representing the Geometry cell.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
938 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataContainerReference

Edit
This command class launches the Vista popup GUI.

GetVistaAFDDesignProperties
This query takes a container reference and returns the Data Entity which contains user settings and
properties for the VistaAFD Design container.

Return Reference to the requested Data Entity

Type DataReference

Data Entities
VistaAFDDesign
Design represents a VistaAFD throughflow calculation used to define the blade profiles

Properties
Alpha1

User input, IGV exit angle

Type Quantity

Read Only No

Alpha3

User input, OGV exit angle

Type Quantity

Read Only No

AlphaOGVHub

OGV hub gas exit angle

Type Quantity

Read Only No

AlphaOGVMean

OGV mean gas exit angle

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 939
TurboSystems

AlphaRotHub

Rotor hub gas exit angle

Type Quantity

Read Only No

AlphaRotMean

Rotor mean gas exit angle

Type Quantity

Read Only No

Blade

Blade number to export to Bladegen (0=IGV, 1=Rotor, 2=OGV)

Type int

Read Only No

BladeBetaExit

Blade exit angles

Type List<List<float>>

Read Only No

BladeBetaInlet

Blade inlet angles

Type List<List<float>>

Read Only No

BladeOption

Blade option for export to BladeGen

Type BladeType

Read Only No

BMunits

BladeGen/BladeEditor units

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
940 of ANSYS, Inc. and its subsidiaries and affiliates.
BMunitsOption

BladeGen/BladeEditor units option

Type BMunitsType

Read Only No

DeHallerOGVHub

OGV hub DeHaller number

Type float

Read Only No

DeHallerOGVMean

OGV mean DeHaller number

Type float

Read Only No

DeHallerRotHub

Rotor hub DeHaller number

Type float

Read Only No

DeHallerRotMean

Rotor mean DeHaller number

Type float

Read Only No

DevIGVHub

IGV hub deviation

Type Quantity

Read Only No

DevIGVMean

IGV mean deviation

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 941
TurboSystems

DevOGVHub

OGV hub deviation

Type Quantity

Read Only No

DevOGVMean

OGV mean deviation

Type Quantity

Read Only No

DevRotHub

Rotor hub deviation

Type Quantity

Read Only No

DevRotMean

Rotor mean deviation

Type Quantity

Read Only No

DfOGVHub

OGV hub diffusion factor

Type float

Read Only No

DfOGVMean

OGV mean diffusion factor

Type float

Read Only No

DfRotHub

Rotor hub diffusion factor

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
942 of ANSYS, Inc. and its subsidiaries and affiliates.
DfRotMean

Rotor mean diffusion factor

Type float

Read Only No

Diameter

User input, outer diameter

Type Quantity

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Eta

Aerodynamic efficiency

Type float

Read Only No

EtaInput

User input, efficiency estimate

Type float

Read Only No

EtaTS

System efficiency (t-s)

Type float

Read Only No

EtaTSPipe

Downstream system efficiency (t-s)

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 943
TurboSystems

EtaTT

System efficiency (t-t)

Type float

Read Only No

HeadRise

User input, total head rise

Type Quantity

Read Only No

HtrIn

User input, hub/tip rotor inlet

Type float

Read Only No

HtrOut

User input, hub/tip rotor outlet

Type float

Read Only No

HubLoadParam

User input, hub loading parameter

Type float

Read Only No

HubVelFactor

User input, hub velocity deficit factor

Type float

Read Only No

HubX

Hub annulus X-coords

Type List<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
944 of ANSYS, Inc. and its subsidiaries and affiliates.
HubY

Hub annulus Y-coords

Type List<Quantity>

Read Only No

IGV

User input, IGV option

Type bool

Read Only No

IGVhubThickX

IGV hub thickness X-coord

Type List<float>

Read Only No

IGVhubThickY

IGV hub thickness Y-coord

Type List<Quantity>

Read Only No

IGVleadingX

IGV leading edge X-coords

Type List<Quantity>

Read Only No

IGVleadingY

IGV leading edge Y-coords

Type List<Quantity>

Read Only No

IGVshrThickX

IGV shroud thickness X-coord

Type List<float>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 945
TurboSystems

IGVshrThickY

IGV shroud thickness Y-coord

Type List<Quantity>

Read Only No

IGVthetaLE

IGV leading edge theta

Type List<float>

Read Only No

IGVtrailingX

IGV trailing edge X-coords

Type List<Quantity>

Read Only No

IGVtrailingY

IGV trailing edge Y-coords

Type List<Quantity>

Read Only No

ImperialUnits

User input, Imperial units option

Type bool

Read Only No

InnerIter

User input, number of inner loop design calculation iterations

Type int

Read Only No

Layer1

Intermediate spanwise layer1 for Export

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
946 of ANSYS, Inc. and its subsidiaries and affiliates.
Layer2

Intermediate spanwise layer2 for Export

Type bool

Read Only No

Layer3

Intermediate spanwise layer3 for Export

Type bool

Read Only No

LoadHub

Rotor hub loading

Type float

Read Only No

LoadMean

Rotor mean loading

Type float

Read Only No

MassFlow

User input, mass flow rate

Type Quantity

Read Only No

MaxLoadHub

Rotor maximum hub loading

Type float

Read Only No

MaxLoadMean

Rotor maximum mean loading

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 947
TurboSystems

MixLoss

User input, downstream mixing losses

Type float

Read Only No

NMain

Number of blades in each row

Type List<int>

Read Only No

OGV

User input, OGV option

Type bool

Read Only No

OGVhubThickX

OGV hub thickness X-coord

Type List<float>

Read Only No

OGVhubThickY

OGV hub thickness Y-coord

Type List<Quantity>

Read Only No

OGVleadingX

OGV leading edge X-coords

Type List<Quantity>

Read Only No

OGVleadingY

OGV leading edge Y-coords

Type List<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
948 of ANSYS, Inc. and its subsidiaries and affiliates.
OGVshrThickX

OGV shroud thickness X-coord

Type List<float>

Read Only No

OGVshrThickY

OGV shroud thickness Y-coord

Type List<Quantity>

Read Only No

OGVthetaLE

OGV leading edge theta

Type List<float>

Read Only No

OGVtrailingX

OGV trailing edge X-coords

Type List<Quantity>

Read Only No

OGVtrailingY

OGV trailing edge Y-coords

Type List<Quantity>

Read Only No

Omega

User input, rotational speed

Type Quantity

Read Only No

OuterIter

User input, number of outer loop design calculation iterations

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 949
TurboSystems

Pdyn

Outlet dynamic pressure

Type Quantity

Read Only No

PdynPipe

Downstream dynamic pressure

Type Quantity

Read Only No

PhiHub

Rotor hub flow coefficient

Type float

Read Only No

PhiMean

Rotor mean flow coefficient

Type float

Read Only No

Power

Power

Type Quantity

Read Only No

RatioIGV

User input, IGV aspect ratio

Type float

Read Only No

RatioOGV

User input, OGV aspect ratio

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
950 of ANSYS, Inc. and its subsidiaries and affiliates.
RatioRotor

User input, Rotor aspect ratio

Type float

Read Only No

RotorHubThickX

Rotor hub thickness X-coord

Type List<float>

Read Only No

RotorHubThickY

Rotor hub thickness Y-coord

Type List<Quantity>

Read Only No

RotorLeadingX

Rotor leading edge X-coords

Type List<Quantity>

Read Only No

RotorLeadingY

Rotor leading edge Y-coords

Type List<Quantity>

Read Only No

RotorShrThickX

Rotor shroud thickness X-coord

Type List<float>

Read Only No

RotorShrThickY

Rotor shroud thickness Y-coord

Type List<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 951
TurboSystems

RotorThetaLE

Rotor leading edge theta

Type List<float>

Read Only No

RotorTrailingX

Rotor trailing edge X-coords

Type List<Quantity>

Read Only No

RotorTrailingY

Rotor trailing edge Y-coords

Type List<Quantity>

Read Only No

Sc90MaxIter

User input, maximum number of solver iterations

Type int

Read Only No

Sc90Relax

User input, solver relaxation factor

Type float

Read Only No

Sc90Tol

User input, solver tolerance

Type float

Read Only No

ShrX

Shroud annulus X-coords

Type List<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
952 of ANSYS, Inc. and its subsidiaries and affiliates.
ShrY

Shroud annulus Y-coords

Type List<Quantity>

Read Only No

SIunits

User input, SI units option

Type bool

Read Only No

Span

Spanwise fractions

Type List<float>

Read Only No

StagPressure

User input, inlet stagnation pressure

Type Quantity

Read Only No

StagTemp

User input, inlet stagnation temperature

Type Quantity

Read Only No

Torque

Torque

Type Quantity

Read Only No

TrimIGV

User input, IGV profile trim

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 953
TurboSystems

TrimOGV

User input, OGV profile trim

Type float

Read Only No

TrimRotor

User input, Rotor profile trim

Type float

Read Only No

VanesIGV

User input, IGV number of vanes

Type int

Read Only No

VanesOGV

User input, OGV number of vanes

Type int

Read Only No

VanesRotor

User input, Rotor number of vanes

Type int

Read Only No

VistaAFDTitle

Editor Title

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
954 of ANSYS, Inc. and its subsidiaries and affiliates.
Vista AFD Meanline
This container holds Meanline data for an instance of Vista AFD.

Methods
Edit
This command class launches the Vista popup GUI.

GetVistaAFDMeanlineProperties
This query takes a container reference and returns the Data Entity which contains user settings and
properties for the VistaAFD Meanline container.

Return Reference to the requested Data Entity

Type DataReference

Import
This command imports Vista data into the Blade Design cell from an existing BladeGen file. If no appro-
priate Vista data is found in the specified BladeGen file, an error message is generated.

template1 = GetTemplate(TemplateName="VistaCPD")
system1 = template1.CreateSystem()
bladeDesign1 = system1.GetContainer(ComponentName="Blade Design")
bladeDesign1.Import(FilePath="myfilepath/pump.bgd")

Required Arguments

FileName Name, and path, of the BladeGen file to be imported.

Type string

Data Entities
VistaAFDMeanline
Meanline represents a VistaAFD meanline calculation as an initial 1D design

Properties
Alpha1

User input, IGV exit angle

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 955
TurboSystems

Alpha3

User input, OGV exit angle

Type Quantity

Read Only No

AlphaOGVHub

OGV hub gas exit angle

Type Quantity

Read Only No

AlphaOGVMean

OGV mean gas exit angle

Type Quantity

Read Only No

AlphaRotHub

Rotor hub gas exit angle

Type Quantity

Read Only No

AlphaRotMean

Rotor mean gas exit angle

Type Quantity

Read Only No

DeHallerOGVHub

OGV hub DeHaller number

Type float

Read Only No

DeHallerOGVMean

OGV mean DeHaller number

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
956 of ANSYS, Inc. and its subsidiaries and affiliates.
DeHallerRotHub

Rotor hub DeHaller number

Type float

Read Only No

DeHallerRotMean

Rotor mean DeHaller number

Type float

Read Only No

Diameter

User input, outer diameter

Type Quantity

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Eta

Aerodynamic efficiency

Type float

Read Only No

EtaInput

User input, efficiency estimate

Type float

Read Only No

EtaTS

System efficiency (t-s)

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 957
TurboSystems

EtaTSPipe

Downstream system efficiency (t-s)

Type float

Read Only No

EtaTT

System efficiency (t-t)

Type float

Read Only No

HeadRise

User input, total head rise

Type Quantity

Read Only No

HtrIn

User input, hub/tip rotor inlet

Type float

Read Only No

HtrOut

User input, hub/tip rotor outlet

Type float

Read Only No

HubLoadParam

User input, hub loading parameter

Type float

Read Only No

HubVelFactor

User input, hub velocity deficit factor

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
958 of ANSYS, Inc. and its subsidiaries and affiliates.
HubX

Hub annulus X-coords

Type List<Quantity>

Read Only No

HubY

Hub annulus Y-coords

Type List<Quantity>

Read Only No

IGV

User input, IGV option

Type bool

Read Only No

ImperialUnits

User input, Imperial units option

Type bool

Read Only No

LoadHub

Rotor hub loading

Type float

Read Only No

LoadMean

Rotor mean loading

Type float

Read Only No

MassFlow

User input, mass flow rate

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 959
TurboSystems

MaxLoadHub

Rotor maximum hub loading

Type float

Read Only No

MaxLoadMean

Rotor maximum mean loading

Type float

Read Only No

MixLoss

User input, downstream mixing losses

Type float

Read Only No

OGV

User input, OGV option

Type bool

Read Only No

Omega

User input, rotational speed

Type Quantity

Read Only No

Pdyn

Outlet dynamic pressure

Type Quantity

Read Only No

PdynPipe

Downstream dynamic pressure

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
960 of ANSYS, Inc. and its subsidiaries and affiliates.
PhiHub

Rotor hub flow coefficient

Type float

Read Only No

PhiMean

Rotor mean flow coefficient

Type float

Read Only No

Power

Power

Type Quantity

Read Only No

RatioIGV

User input, IGV aspect ratio

Type float

Read Only No

RatioOGV

User input, OGV aspect ratio

Type float

Read Only No

RatioRotor

User input, Rotor aspect ratio

Type float

Read Only No

ShrX

Shroud annulus X-coords

Type List<Quantity>

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 961
TurboSystems

ShrY

Shroud annulus Y-coords

Type List<Quantity>

Read Only No

SIunits

User input, SI units option

Type bool

Read Only No

StagPressure

User input, inlet stagnation pressure

Type Quantity

Read Only No

StagTemp

User input, inlet stagnation temperature

Type Quantity

Read Only No

Torque

Torque

Type Quantity

Read Only No

TrimIGV

User input, IGV profile trim

Type float

Read Only No

TrimOGV

User input, OGV profile trim

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
962 of ANSYS, Inc. and its subsidiaries and affiliates.
TrimRotor

User input, Rotor profile trim

Type float

Read Only No

VanesIGV

User input, IGV number of vanes

Type int

Read Only No

VanesOGV

User input, OGV number of vanes

Type int

Read Only No

VanesRotor

User input, Rotor number of vanes

Type int

Read Only No

VistaAFDTitle

Editor Title

Type string

Read Only No

Vista CCD
This container holds Analysis data for an instance of Vista CCD.

Methods
CreateBladeDesign
This command class creates a new BladeGen model. An up-to-date BladeGen cell appears on the project
schematic containing the new model.

Return Container representing the BladeGen cell.

Type DataContainerReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 963
TurboSystems

CreateGeometry
This command class creates a new BladeEditor model. An up-to-date Geometry cell appears on the
project schematic containing the new model.

Return Container representing the Geometry cell.

Type DataContainerReference

CreateTF
This command class creates a new Turbo Setup system, a new geometry component (BladeGen or
BladeEditor) and a Vista TF system. The geometry and Vista TF systems are linked appropriately and
inputs populated appropriately ready for update.

Optional Arguments

UseBladegen Indicates whether to use a Bladegen cell or a BladeEditor(Geometry) cell

Type bool

Default Value False

CreateThroughflow
This command class creates a new throughflow system. The system, comprising Geometry, Setup,
Solution and Results cells, is created on the project schematic and is updated performing the throughflow
analysis automatically.

Optional Arguments

UseBladegen Indicates whether to use a Bladegen cell or a BladeEditor(Geometry) cell

Type bool

Default Value False

CreateTurboflow
This command class creates new Turbo Setup, Geometry (BladeGen or BladeEditor) and Turbomachinery
Fluid Flow systems. The new systems appear on the project schematic. The Turbo Setup and Geometry
components are updated. The Turbo Fluid Flow system components are initialised and the Turbo Mesh
component is connected to the upstream Geometry.

Optional Arguments

UseBladegen Indicates whether to use a Bladegen cell or a BladeEditor(Geometry) cell

Type bool

Default Value False

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
964 of ANSYS, Inc. and its subsidiaries and affiliates.
CreateTurboSetup
This command class creates a new Turbo Setup system. The Turbo Setup is populated with data from
the Vista Tools component it's launched from

Return Container representing the Turbo Setup cell.

Type DataContainerReference

Edit
This command class launches the Vista popup GUI.

GetVistaCCDBladeDesignProperties
This query takes a container reference and returns the Data Entity which contains user settings and
properties for the VistaCCD Blade Design container.

Return Reference to the requested Data Entity

Type DataReference

Import
This command imports Vista data into the Blade Design cell from an existing BladeGen file. If no appro-
priate Vista data is found in the specified BladeGen file, an error message is generated.

template1 = GetTemplate(TemplateName="VistaCPD")
system1 = template1.CreateSystem()
bladeDesign1 = system1.GetContainer(ComponentName="Blade Design")
bladeDesign1.Import(FilePath="myfilepath/pump.bgd")

Required Arguments

FileName Name, and path, of the BladeGen file to be imported.

Type string

Data Entities
VistaCCDBladeDesign
This data entity provides access to the properties which define the VistaCCD project. This includes both
the input and the results properties.

Properties
Acentric

This property specifies the acentric factor for the working fluid. Note that this is only available when
MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 965
TurboSystems

Alpha3

This property specifies the flow angle at the impeller inlet in the absolute reference frame.

Type Quantity

Read Only No

Alpha5rms

This property reports the absolute flow angle at the impeller trailing edge.

Type Quantity

Read Only No

AnChkRatio

This property reports the annulus choke ratio.

Type float

Read Only No

B5

This property reports the axial distance between hub and shroud at the impeller trailing edge (tip width).

Type Quantity

Read Only No

Beta5rms

This property reports the relative flow angle at the impeller trailing edge.

Type Quantity

Read Only No

BetaBlade3HubUser

This property specifies the hub leading edge blade angle. Note that this is NOT available when the
StackingOption is set to 'Radial'.

Type Quantity

Read Only No

BetaBlade3ShrUser

This property specifies the impeller shroud leading edge blade angle. Note that this is only available
when the ShroudDiameterOption is set to 'Angle'.

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
966 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

BetaBlade5

This property specifies the impeller backsweep angle.

Type Quantity

Read Only No

BetaBladeLEhub

This property reports the blade angle at the impeller leading edge hub location.

Type Quantity

Read Only No

BetaBladeLErms

This property reports the blade angle at the impeller leading edge meanline location.

Type Quantity

Read Only No

BetaBladeLEshr

This property reports the blade angle at the impeller leading edge shroud location.

Type Quantity

Read Only No

BetaLEhub

This property reports the relative flow angle at the impeller leading edge hub location.

Type Quantity

Read Only No

BetaLErms

This property reports the relative flow angle at the impeller leading edge meanline location.

Type Quantity

Read Only No

BetaLEshr

This property reports the relative flow angle at the impeller leading edge shroud location.

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 967
TurboSystems

Read Only No

BMunitsOption

This property specifies the units used when creating a new BladeGen/BladeEditor model. Note that this
is independent of the units used in the VistaCCD popup GUI.

Available options:

mm
cm
inches
ft
m

Type BMunitsType

Read Only No

ChkRatio

This property reports the impeller choke ratio.

Type float

Read Only No

ChokeUser

This property specifies the impeller choke ratio. Note that this is only available when the IncidenceOption
is set to 'choke'.

Type float

Read Only No

ClearanceOption

This property specifies impeller tip clearance is specified. 'Ratio' indicates that the tip clearance is specified
as a fraction of the tip width 'User' specifies that the clearance will be defined directly by the user.

Available options:

Ratio
User

Type ClearanceType

Read Only No

ClearRatio

This property reports the axial tip clearance ratio of the impeller.

Type float

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
968 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

ClearRatioUser

This property specifies the ratio of the impeller tip clearance to the tip width. Note that this is only
available when ClearanceOption is set to 'Ratio'.

Type float

Read Only No

ClearUser

This property specifies the value of the impeller tip clearance. Note that this is only available when
ClearanceOption is set to 'User'.

Type Quantity

Read Only No

CorrelationOption

This property specifies the correlation used to calculate the stage efficiency. Note that this is only
available when the EfficiencyOption is set to 'Correlation'.

Available options:

CaseyRobinson
CaseyMarty
Rodgers

Type EtaCorrelType

Read Only No

Cp_A0

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the constant component (coefficient of T^0) of
the lower temperature range polynomial. Note that this is only available when MaterialPropsOption is
set to 'User' and the GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_A1

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^1 of the lower temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 969
TurboSystems

Cp_A2

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^2 of the lower temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_A3

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^3 of the lower temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_A4

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^4 of the lower temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_A5

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^5 of the lower temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_A6

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^6 of the lower temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
970 of ANSYS, Inc. and its subsidiaries and affiliates.
Cp_A7

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^7 of the lower temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_Amax

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the maximum temperature limit for which the
lower temperature range polynomial is applicable. Note that this is only available when MaterialProp-
sOption is set to 'User' and the GasModelOption is set to 'Real'.

Type float

Read Only No

Cp_Amin

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the minimum temperature limit for which the
lower temperature range polynomial is applicable. Note that this is only available when MaterialProp-
sOption is set to 'User' and the GasModelOption is set to 'Real'.

Type float

Read Only No

Cp_B0

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the constant component (coefficient of T^0) of
the upper temperature range polynomial. Note that this is only available when MaterialPropsOption is
set to 'User' and the GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_B1

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^1 of the upper temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 971
TurboSystems

Cp_B2

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^2 of the upper temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_B3

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^3 of the upper temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_B4

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^4 of the upper temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_B5

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^5 of the upper temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_B6

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^6 of the upper temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
972 of ANSYS, Inc. and its subsidiaries and affiliates.
Cp_B7

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the coefficient of T^7 of the upper temperature
range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the
GasModelOption is set to 'Real'.

Type double

Read Only No

Cp_Bmax

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature
over two temperature ranges. This property specifies the maximum temperature limit for which the
upper temperature range polynomial is applicable. Note that this is only available when MaterialProp-
sOption is set to 'User' and the GasModelOption is set to 'Real'.

Type float

Read Only No

CriticalPressure

This property specifies the critical pressure for the working fluid. Note that this is only available when
MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type Quantity

Read Only No

CriticalTemp

This property specifies the critical temperature for the working fluid. Note that this is only available
when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type Quantity

Read Only No

CriticalVol

This property specifies the critical volume for the working fluid. Note that this is only available when
MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type Quantity

Read Only No

D3Hub

This property specifies the hub inlet diameter for the impeller.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 973
TurboSystems

D3ShrUser

This property specifies the impeller shroud diameter at the leading edge. Note that this is only available
when the ShroudDiameterOption is set to 'Diameter'.

Type Quantity

Read Only No

D5

This property reports the diameter at the impeller trailing edge (tip diameter).

Type Quantity

Read Only No

Diffuser

This property specifies whether the diffuser section is vaned or vaneless.

Available options:

Vaned
Vaneless

Type DiffuserType

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

DLEhub

This property reports the diameter at the impeller leading edge hub location.

Type Quantity

Read Only No

DLErms

This property reports the diameter at the impeller leading edge meanline location.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
974 of ANSYS, Inc. and its subsidiaries and affiliates.
DLEshr

This property reports the diameter at the impeller leading edge shroud location.

Type Quantity

Read Only No

EfficiencyOption

This property specifies whether to use a correlation to automatically calculate the compressor stage
efficiency, or to use a user-defined efficiency.

Available options:

Correlation
User

template1 = GetTemplate(TemplateName="VistaCCD")
system1 = template1.CreateSystem()
bladeDesign1 = system1.GetContainer(ComponentName="Blade Design")
vistaCCDProperties1 = bladeDesign1.GetVistaCCDBladeDesignProperties()
vistaCCDProperties1.EfficiencyOption = "Correlation"

Type EtaType

Read Only No

EtaIsen

This property reports the isentropic efficiency for the compressor stage.

Type float

Read Only No

EtaIsenImp

This property reports the isentropic efficiency for the compressor impeller.

Type float

Read Only No

EtaIsenImpUser

This property specifies the user defined impeller isentropic efficiency. Note that this is only available
when the ImpellerEfficiencyOption is set to 'User'.

Type float

Read Only No

EtaIsenUser

This property specifies the user defined stage isentropic efficiency. Note that this is only available when
the UserEfficiencyOption is set to 'Isentropic'.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 975
TurboSystems

Type float

Read Only No

EtaPoly

This property reports the polytropic efficiency for the compressor stage.

Type float

Read Only No

EtaPolyImp

This property reports the polytropic efficiency for the compressor impeller.

Type float

Read Only No

EtaPolyUser

This property specifies the user defined stage polytropic efficiency. Note that this is only available when
the UserEfficiencyOption is set to 'Polytropic'.

Type float

Read Only No

Gamma

This property reports the ratio of specific heats of the working fluid.

Type float

Read Only No

GammaUser

This property specifies the ratio of specific heats for the working fluid. Note that this is only available
when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Ideal'.

Type float

Read Only No

GasModelOption

This property specifies whether to treat the working fluid as an Ideal or a Real gas.

Available options:

Ideal
Real

Type GasModelType

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
976 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

GeometryStyle

This property specifies the approach taken when creating a new Geometry model from a successful
VistaCCD calculation.

Available options:

Interactive
Parametric

Type GeometryStyleType

Read Only No

H05

This property reports the total enthalpy at the impeller trailing edge.

Type Quantity

Read Only No

H0LE

This property reports the stagnation enthalpy at the impeller leading edge.

Type Quantity

Read Only No

Impeller

This property specifies whether the impeller is unshrouded or shrouded.

Available options:

Unshrouded
Shrouded

Type ImpellerType

Read Only No

ImpellerEfficiencyOption

This property specifies whether to automatically calculate the impeller efficiency by linking this to the
stage efficiency, or to use a user-defined efficiency.

Available options:

LinkToStage
User

Type EtaImpType

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 977
TurboSystems

Read Only No

ImpellerLength

This property specifies the impeller axial length to tip diameter ratio.

Type float

Read Only No

ImpellerLengthOption

This property specifies whether the impeller length ratio is calculated automatically, or specified by the
user.

Available options:

Automatic
User

Type ImpellerLengthType

Read Only No

ImpellerLengthUserOpt

This property specifies whether the impeller axial length ratio will be defined by the user.

Type bool

Read Only No

IncidenceOption

This property specifies the method used to calculate the incidence at the impeller shroud. The incidence
may be either specified directly or calculated using the specified choke ratio.

Available options:

incidence
choke

Type IncidenceType

Read Only No

IncLEhub

This property reports the impeller incidence at the hub location.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
978 of ANSYS, Inc. and its subsidiaries and affiliates.
IncLErms

This property reports the impeller incidence at the meanline location.

Type Quantity

Read Only No

IncLEshr

This property reports the impeller incidence at the shroud location.

Type Quantity

Read Only No

IncShrUser

This property specifies the incidence at the impeller shroud. Note that this is only available when the
IncidenceOption is set to 'incidence'.

Type Quantity

Read Only No

LEInclination

This property reports the leading edge angle of inclination in the meridional plane.

Type Quantity

Read Only No

LEInclinationUser

This property specifies the inclination of the leading edge relative to a radial line in the meridional view.

Type Quantity

Read Only No

Loading

This property reports the impeller loading parameter (delH/U^2).

Type float

Read Only No

M5rms

This property reports the absolute Mach number at the impeller trailing edge.

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 979
TurboSystems

MachU5

This property reports the blade Mach number at the impeller trailing edge (tip Mach number).

Type float

Read Only No

MassFlow

This property specifies the design point mass flow rate passing through the compressor stage.

Type Quantity

Read Only No

MaterialNameSelection

This property specifies the name of the working fluid, as selected from the database. Note that this is
only available when the MaterialPropsOption is set to 'Database'.

Available options:

air
carbon_dioxide
hydrogen
methane
nitrogen
oxygen
parahydrogen
propylene
R123
R125
R134a
R141b
R142b
R245fa
water

template1 = GetTemplate(TemplateName="VistaCCD")
system1 = template1.CreateSystem()
bladeDesign1 = system1.GetContainer(ComponentName="Blade Design")
vistaCCDProperties1 = bladeDesign1.GetVistaCCDBladeDesignProperties()
vistaCCDProperties1.MaterialPropsOption = "Database"
vistaCCDProperties1.MaterialNameSelection = "nitrogen"

Type MaterialNamesList

Read Only No

MaterialPropsOption

This property specifies whether the working fluid properties are chosen from the materials database or
specified directly by the user.

Available options:

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
980 of ANSYS, Inc. and its subsidiaries and affiliates.
 Database
User

Type MaterialPropsType

Read Only No

MerVelGrad

This property specifies the gradient of the velocity profile from hub to shroud at the impeller leading
edge. The gradient is set using the ratio of the meridional velocity at the shroud leading edge radius
to that at the average leading edge radius.

Type float

Read Only No

MrelLEhub

This property reports the relative Mach number at the impeller leading edge hub location.

Type float

Read Only No

MrelLErms

This property reports the relative Mach number at the impeller leading edge meanline location.

Type float

Read Only No

MrelLEshr

This property reports the relative Mach number at the impeller leading edge shroud location.

Type float

Read Only No

MrmsLE

This property reports the absolute Mach number at the impeller leading edge meanline location.

Type float

Read Only No

Mu

This property reports the dynamic viscosity of the working fluid.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 981
TurboSystems

MuUser

This property specifies the dynamic viscosity of the working fluid.

Type Quantity

Read Only No

NMain

This property specifies the number of impeller main vanes.

Type int

Read Only No

NormalToHubLE

This property specifies that the main impeller blade leading is normal to the hub curve

Type bool

Read Only No

Ns

This property reports the specific speed of the impeller.

Type float

Read Only No

NSplit

This property specifies the number of impeller splitter vanes. Note that this MUST be a multiple of the
number of impeller main vanes.

Type int

Read Only No

Nu

This property reports the kinematic viscosity of the working fluid.

Type Quantity

Read Only No

NuUser

This property specifies the kinematic viscosity of the working fluid.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
982 of ANSYS, Inc. and its subsidiaries and affiliates.
Omega

This property specifies the design point rotational speed of the impeller.

Type Quantity

Read Only No

P05rms

This property reports the total pressure at the impeller trailing edge.

Type Quantity

Read Only No

P5rms

This property reports the static pressure at the impeller trailing edge.

Type Quantity

Read Only No

PIF

This property reports the power input factor of the compressor.

Type float

Read Only No

PIFOption

This property specifies whether the power input factor is calculated using a correlation, or specified by
the user.

Available options:

Correlation
User

Type PIFType

Read Only No

PIFUser

This property specifies the user defined power input factor. Note that this is only available when the
PIFOption is set to 'User'.

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 983
TurboSystems

Power

This property reports the impeller power.

Type Quantity

Read Only No

PressureRatio

This property specifies the design point total-to-total pressure ratio for the compressor stage.

Type float

Read Only No

PreswirlOption

This property specifies how the radial distribution of the preswirl angle is calculated.

Available options:

constant
free
forced
linear

Type PreswirlType

Read Only No

RakeAngle

This property specifies the impeller rake angle (trailing edge lean angle).

Type Quantity

Read Only No

Reb5

This property reports the Reynolds number based on the impeller tip width dimension.

Type float

Read Only No

ReCorrectOpt

This property specifies if the Reynolds number correction is to be made to the stage efficiency correlation.
Note that this is only available when the EfficiencyOption is set to 'Correlation'.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
984 of ANSYS, Inc. and its subsidiaries and affiliates.
Red5

This property reports the Reynolds number based on the impeller tip diameter dimension.

Type float

Read Only No

RelVelRatio

This property specifies the ratio of the relative velocity at the trailing edge to that at the leading edge
shroud location.

Type float

Read Only No

RelVelRatioMod

This property reports the ratio of the rms relative velocity at the trailing edge to the shroud relative
velocity at the leading edge

Type float

Read Only No

RGas

This property reports the specific gas constant of the working fluid.

Type Quantity

Read Only No

RUser

This property specifies the specific gas constant for the working fluid. Note that this is only available
when MaterialPropsOption is set to 'User'.

Type Quantity

Read Only No

S5

This property reports the specific entropy at the impeller trailing edge.

Type Quantity

Read Only No

ShrLELoc

This property specifies the main impeller blade leading edge location on the shroud

Type float

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 985
TurboSystems

Read Only No

ShroudDiameterOption

This property specifies the method used to calculate the impeller shroud diameter at the leading edge.
'Diameter' allows the diameter to be directly specified. 'Angle' indicates that the diameter will be calcu-
lated from the shroud leading edge blade angle. 'Optimum' calculates the diameter such that the relative
Mach number at the shroud leading edge is minimised.

Available options:

Diameter
Angle
Optimum

Type ShroudDiameterType

Read Only No

SLE

This property reports the specific entropy at the impeller leading edge.

Type Quantity

Read Only No

StackingOption

This property specifies the method used to calculate the leading edge blade angles. Using the radial
approach both hub and meanline leading edge blade angles are calculated from the shroud leading
edge blade angle. Using either tangential or sine based approaches, the hub leading edge blade angle
is user defined and the meanline leading edge blade angle is interpolated from the hub and shroud
blade angles.

Available options:

Radial
Tan
Sin

Type StackingType

Read Only No

StagPressure

This property specifies the design point stagnation pressure at the inlet to the compressor stage.

Type Quantity

Read Only No

StagTemp

This property specifies the design point stagnation temperature at the inlet to the compressor stage.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
986 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Quantity

Read Only No

SurfaceFinish

This property specifies the surface finish of the impeller. The surface roughness has a secondary effect
on the calculated efficiency.

Available options:

Machined
Cast

Type RoughnessType

Read Only No

SzrFlowCoeff

This property reports the impeller flow coefficient.

Type float

Read Only No

T05rms

This property reports the total temperature at the impeller trailing edge.

Type Quantity

Read Only No

ThkHub

This property specifies the hub vane normal thickness.

Type Quantity

Read Only No

ThkShr

This property specifies the shroud vane normal thickness.

Type Quantity

Read Only No

ThroatAreaLE

This property reports the throat area at the impeller leading edge.

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 987
TurboSystems

Read Only No

TipCorrectOpt

This property specifies if the tip clearance and shroud correction is to be made to the stage efficiency
correlation. Note that this is only available when the EfficiencyOption is set to 'Correlation'.

Type bool

Read Only No

U5

This property reports the blade speed at the impeller trailing edge (tip speed).

Type Quantity

Read Only No

UserEfficiencyOption

This property specifies whether the user defined stage efficiency is isentropic or polytropic. Note that
this is only available when the EfficiencyOption is set to 'User'.

Available options:

Isentropic
Polytropic

Type EtaUserType

Read Only No

V5rms

This property reports the absolute velocity at the impeller trailing edge.

Type Quantity

Read Only No

ViscosityOption

This property specifies the method used to set the viscosity of the working fluid. The viscosity may be
calculated using Sutherland's law, specified as a constant dynamic viscosity or as a constant kinematic
viscosity. Note that this is only available when MaterialPropsOption is set to 'User'.

Available options:

Sutherland
Dynamic
Kinematic

Type ViscosityType

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
988 of ANSYS, Inc. and its subsidiaries and affiliates.
ViscosityOptionR145

OBSOLETE PROPERTY RETAINED FOR BACKWARDS COMPATIBILITY IN POST MIGRATION STEP

This property specifies the method used to set the kinematic viscosity of the working fluid. The kinematic
viscosity may either be calculated using Sutherland's law for Air, or defined as a constant value by the
user. Note that this is only available when MaterialPropsOption is set to 'User'.

Available options:

Sutherland
User

Type NuUserType

Read Only No

VmLEhub

This property reports the meridional velocity at the impeller leading edge hub location.

Type Quantity

Read Only No

VmLErms

This property reports the meridional velocity at the impeller leading edge meanline location.

Type Quantity

Read Only No

VmLEshr

This property reports the meridional velocity at the impeller leading edge shroud location.

Type Quantity

Read Only No

VmRatioLE

This property reports the ratio of the shroud meridional velocity to the RMS meridional velocity at the
leading edge.

Type float

Read Only No

VrmsLE

This property reports the absolute velocity at the impeller leading edge meanline location.

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 989
TurboSystems

Read Only No

VwLEhub

This property reports the tangential velocity at the impeller leading edge hub location.

Type Quantity

Read Only No

VwLErms

This property reports the tangential velocity at the impeller leading edge meanline location.

Type Quantity

Read Only No

VwLEshr

This property reports the tangential velocity at the impeller leading edge shroud location.

Type Quantity

Read Only No

VwRatioLE

This property reports the ratio of the shroud swirl velocity to the RMS swirl velocity at the leading edge.

Type float

Read Only No

VwRatioUser

This property specifies the ratio of the inlet tangential velocity at the shroud to that at the meanline.
Note that this property is only valid when the PreswirlOption is set to linear.

Type float

Read Only No

W5rms

This property reports the relative velocity at the impeller trailing edge.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
990 of ANSYS, Inc. and its subsidiaries and affiliates.
Vista CCM
This container holds Analysis data for an instance of Vista CCM.

Methods
Edit
This command class launches the Vista popup GUI.

GetVistaCCMBladeDesignProperties
This query takes a container reference and returns the Data Entity which contains user settings and
properties for the VistaCCD Performance Map container.

Return Reference to the requested Data Entity

Type DataReference

Data Entities
VistaCCMBladeDesign
Setup represents a VistaCCM project definition.

Properties
Alpha3

Inlet angle

Type Quantity

Read Only No

B5

User input: impeller tip width

Type Quantity

Read Only No

BetaBlade5

User input: impeller blade exit angle

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 991
TurboSystems

BetaBladeLEhub

User input: hub vane angle at the leading edge

Type Quantity

Read Only No

BetaBladeLEshr

User input: shroud vane angle at the leading edge

Type Quantity

Read Only No

ConditionsFromUpstream

Flag to choose whether to update operating conditions from upstream cell or not

Type bool

Read Only No

D5

User input: impeller exit diameter

Type Quantity

Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

DLEhub

User input: Hub diameter at the leading edge

Type Quantity

Read Only No

DLEshr

User input: shroud diameter at the leading edge

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
992 of ANSYS, Inc. and its subsidiaries and affiliates.
EffPolyData

Results data: Range of polytropic efficiencies

Type List<List<float>>

Read Only No

EtaPoly

Polytropic efficiency

Type float

Read Only No

GammaUser

Ratio of specific heats

Type float

Read Only No

GasModel

Gas model

Type int

Read Only No

ImperialUnits

User input, Imperial units option

Type bool

Read Only No

KDiff

User input: Diffuser type (-1.0 = vaneless, 1.0 = vaned)

Type float

Read Only No

KType

User input: Machine type (-1.0 = process, 1.0 = turbocharger)

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 993
TurboSystems

ListSpeed

Results data: Range of speeds

Type List<float>

Read Only No

Loading

Work factor

Type float

Read Only No

MachU5

Tip Mach number

Type float

Read Only No

MassFlow

Design point mass flow rate

Type Quantity

Read Only No

MassFlowData

Results data: Range of mass flow rates

Type List<List<float>>

Read Only No

NMain

User input: number of main vanes

Type int

Read Only No

NSpeeds

User input, number of speeds

Type int

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
994 of ANSYS, Inc. and its subsidiaries and affiliates.
NSplit

User input: number of splitter vanes

Type int

Read Only No

PIF

Power input factor

Type float

Read Only No

PresRatioData

Results data: Range of pressure ratios

Type List<List<float>>

Read Only No

PressureRatio

Design point pressure ratio

Type float

Read Only No

RUser

Gas constant

Type Quantity

Read Only No

SIunits

User input, SI units option

Type bool

Read Only No

SpeedMax

User input, maximum speed

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 995
TurboSystems

SpeedMaxFixed

User input, maximum speed

Type Quantity

Read Only No

SpeedMin

User input, minimum speed

Type Quantity

Read Only No

SpeedMinFixed

User input, minimum speed

Type Quantity

Read Only No

StagPressure

Inlet stagnation pressure

Type Quantity

Read Only No

StagPressureFixed

Inlet stagnation pressure

Type Quantity

Read Only No

StagTemp

Inlet stagnation temperature

Type Quantity

Read Only No

StagTempFixed

Inlet stagnation temperature

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
996 of ANSYS, Inc. and its subsidiaries and affiliates.
SzrFlowCoeff

Flow coefficient

Type float

Read Only No

ThkHub

User input: Hub vane normal thickness

Type Quantity

Read Only No

ThkShr

User input: shroud vane normal thickness

Type Quantity

Read Only No

ThroatArea

User input: throat area

Type Quantity

Read Only No

TipMachInData

Results data: Range of inlet tip Mach numbers

Type List<List<float>>

Read Only No

TipMachOutData

Results data: Range of outlet tip Mach numbers

Type List<List<float>>

Read Only No

VistaCCMTitle

Editor Title

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 997
TurboSystems

Vista CPD
This container holds Analysis data for an instance of Vista CPD.

Methods
CreateBladeDesign
This command class creates a new BladeGen model. An up-to-date BladeGen cell appears on the project
schematic containing the new model.

Return Container representing the BladeGen cell.

Type DataContainerReference

CreateGeometry
This command class creates a new BladeEditor model. An up-to-date Geometry cell appears on the
project schematic containing the new model.

Return Container representing the Geometry cell.

Type DataContainerReference

CreateThroughflow
This command class creates a new throughflow system. The system, comprising Geometry, Setup,
Solution and Results cells, is created on the project schematic and is updated performing the throughflow
analysis automatically.

Optional Arguments

UseBladegen Indicates whether to use a Bladegen cell or a BladeEditor(Geometry) cell

Type bool

Default Value False

CreateVoluteMesh
This command class creates a new pump volute geometry and mesh. An up-to-date Mesh system appears
on the project schematic containing the new geometry and mesh cells.

Edit
This command class launches the Vista popup GUI.

GetVistaCPDBladeDesignProperties
This query takes a container reference and returns the Data Entity which contains user settings and
properties for the VistaCPD Blade Design container.

Return Reference to the requested Data Entity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
998 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataReference

Import
This command imports Vista data into the Blade Design cell from an existing BladeGen file. If no appro-
priate Vista data is found in the specified BladeGen file, an error message is generated.

template1 = GetTemplate(TemplateName="VistaCPD")
system1 = template1.CreateSystem()
bladeDesign1 = system1.GetContainer(ComponentName="Blade Design")
bladeDesign1.Import(FilePath="myfilepath/pump.bgd")

Required Arguments

FileName Name, and path, of the BladeGen file to be imported.

Type string

Data Entities
VistaCPDBladeDesign
This data entity provides access to the properties which define the VistaCPD project. This includes both
the input and the results properties.

Properties
Alpha2

This property reports the absolute flow angle at the impeller trailing edge.

Type Quantity

Read Only Yes

AlphaIn

This property specifies the absolute flow angle, measured with respect to the tangential direction, at
the leading edge of the pump impeller.

Type Quantity

Read Only No

AreaDiff

This property reports the volute diffuser exit area.

Type Quantity

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 999
TurboSystems

AspectRatio

This property specifies the aspect ratio (height/width) of the rectangular volute cross section. This is
valid when VoluteStyleOpt is 'Rectangular'.

Type float

Read Only No

B2

This property reports the hub to shroud distance at the impeller trailing edge (tip width).

Type Quantity

Read Only Yes

B3

This property reports the width of the volute inlet.

Type Quantity

Read Only Yes

Beta1

This property reports the relative flow angle at the impeller leading edge meanline section.

Type Quantity

Read Only Yes

Beta1Blade

This property reports the impeller leading edge blade angle at the meanline section.

Type Quantity

Read Only Yes

Beta1BladeHub

This property reports the impeller leading edge blade angle at the hub section.

Type Quantity

Read Only Yes

Beta1BladeHubUser

This property specifies the impeller leading edge blade angle at the hub, measured with respect to the
tangential direction. This is valid when the HubBeta1Opt is set to 'User'

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1000 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

Beta1BladeShr

This property reports the impeller leading edge blade angle at the shroud section.

Type Quantity

Read Only Yes

Beta1BladeShrUser

This property specifies the impeller leading edge blade angle at the shroud, measured with respect to
the tangential direction. This is valid when the ShrBeta1Opt is set to 'User'

Type Quantity

Read Only No

Beta1BladeUser

This property specifies the impeller leading edge blade angle at the meanline, measured with respect
to the tangential direction. This is valid when the HubBeta1Opt is set to 'User'

Type Quantity

Read Only No

Beta1Hub

This property reports the relative flow angle at the impeller leading edge hub section.

Type Quantity

Read Only Yes

Beta1Shr

This property reports the relative flow angle at the impeller leading edge shroud section.

Type Quantity

Read Only Yes

Beta2

This property reports the relative flow angle at the impeller trailing edge.

Type Quantity

Read Only Yes

Beta2Blade

This property specifies the blade angle at the impeller trailing edge, measured with respect to the tan-
gential direction.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1001
TurboSystems

Type Quantity

Read Only No

BMExportOption

This property specifies whether the impeller is to be exported as an isolated impeller or coupled to a
volute. The isolated impeller option provides for an extended exit diffuser to assist the analysis process.
If the impeller is coupled to the volute, the exit diffuser is short to match with the volute inlet.

Available options:

Isolated
Coupled

Type ImpellerExportType

Read Only No

BMunitsOption

This property specifies the units used when creating a new BladeGen/BladeEditor model. Note that this
is independent of the units used in the VistaCPD popup GUI.

Available options:

mm
inches

Type BMunitsType

Read Only No

C2

This property reports the absolute flow velocity at the impeller trailing edge.

Type Quantity

Read Only Yes

Cm1

This property reports the meridional flow velocity at the impeller leading edge meanline section.

Type Quantity

Read Only Yes

Cm1Hub

This property reports the meridional flow velocity at the impeller leading edge hub section.

Type Quantity

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1002 of ANSYS, Inc. and its subsidiaries and affiliates.
Cm1Shr

This property reports the meridional flow velocity at the impeller leading edge shroud section.

Type Quantity

Read Only Yes

Cu1

This property reports the tangential flow velocity at the impeller leading edge meanline section.

Type Quantity

Read Only Yes

Cu1Hub

This property reports the tangential flow velocity at the impeller leading edge hub section.

Type Quantity

Read Only Yes

Cu1Shr

This property reports the tangential flow velocity at the impeller leading edge shroud section.

Type Quantity

Read Only Yes

Cu2

This property reports the tangential flow velocity at the impeller trailing edge.

Type Quantity

Read Only Yes

Cus

This property reports the slip velocity at the impeller trailing edge. This is defined as the difference
between the theoretical 'no-slip' tangential flow velocity and the true tangential flow velocity.

Type Quantity

Read Only Yes

D1

This property reports the diameter of the impeller leading edge at the meanline section.

Type Quantity

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1003
TurboSystems

D1Hub

This property reports the diameter of the impeller leading edge at the hub section.

Type Quantity

Read Only Yes

D1Shr

This property reports the diameter of the impeller leading edge at the shroud section.

Type Quantity

Read Only Yes

D2

This property reports the diameter at the impeller trailing edge meanline section (tip diameter).

Type Quantity

Read Only Yes

D2Opt

This property specifies the method used to set the impeller tip diameter. It may be calculated automat-
ically, from a specified head coefficient or the value may be user defined.

Available options:

Automatic
HeadCoeff
User

Type TipDiamType

Read Only No

D2User

This property specifies the impeller tip diameter. This is valid when the D2Opt is set to 'User'.

Type Quantity

Read Only No

DEye

This property reports the impeller shroud diameter at the eye of the impeller.

Type Quantity

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1004 of ANSYS, Inc. and its subsidiaries and affiliates.
DEyeHub

This property reports the impeller hub diameter at the eye of the impeller.

Type Quantity

Read Only Yes

DiamDiff

This property reports the hydraulic diameter of the volute diffuser exit.

Type Quantity

Read Only Yes

DiamDiffUser

This property specifies the value of the volute diffuser exit diameter. This is valid when UserDiamDiff is
set to true.

Type Quantity

Read Only No

DiffRatio

This property reports the diffusion ratio of the impeller.

Type float

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

DShaft

This property reports the impeller shaft diameter.

Type Quantity

Read Only Yes

EfficiencyOption

This property specifies how the impeller efficiencies are calculated.

With this set to 'Automatic' the efficiencies are calculated using empirical correlations. All other options
require the specification of three of the efficiencies.The remaining value is calculated from those specified.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1005
TurboSystems

For example, specifying 'Hydraulic' indicates that the hydraulic efficiency will be calculated and the
volumetric, mechanical and overall pump efficiencies must be specified.

Available options:

Automatic
Hydraulic
Volumetric
Mechanical
Pump

Type EffType

Read Only No

FlowCoeff

This property reports the flow coefficient of the impeller.

Type float

Read Only Yes

Head

This property specifies the design point head rise for the impeller.

Type Quantity

Read Only No

HeadCoeff

This property reports the head coefficient of the impeller.

Type float

Read Only Yes

HeadCoeffUser

This property specifies the head coefficient, used to calculate the impeller tip diameter. This is valid
when the D2Opt is set to 'HeadCoeff'.

Type float

Read Only No

HeightDiff

This property reports the volute diffuser exit height. In the case of a circular outlet, (elliptic volute cross
section), this is the same as the hydraulic diameter.

Type Quantity

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1006 of ANSYS, Inc. and its subsidiaries and affiliates.
HubBeta1Opt

This property specifies the method used to set the impeller leading edge blade angles at the hub and
meanline sections. These blade angles may be calculated relative to the leading edge blade angle at
the shroud using either cosine or cotangent relationships, or they may be defined directly by the user.

Available options:

Cos
Cot
User

Type HubLEBetaType

Read Only No

HubInletDraft

This property specifies the impeller hub inlet draft angle. This is defined as the angle between the hub
and the horizontal line at the hub inlet.

Type Quantity

Read Only No

HydEff

This property reports the hydraulic efficiency of the impeller.

Type float

Read Only Yes

HydEffUser

This property specifies the impeller hydraulic efficiency. This is valid when the EfficiencyOption is set
to 'Volumetric', 'Mechanical' or 'Pump'.

Type float

Read Only No

Inc

This property reports the incidence at the impeller leading edge meanline section.

Type Quantity

Read Only Yes

IncHub

This property reports the incidence at the impeller leading edge hub section.

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1007
TurboSystems

Read Only Yes

IncShr

This property reports the incidence at the impeller leading edge shroud section.

Type Quantity

Read Only Yes

IncShrUser

This property specifies the angle of incidence for the impeller at the shroud. This is valid when the
ShrBeta1Opt is set to 'Incidence'.

Type Quantity

Read Only No

Ks

This property reports the stability factor of the impeller.

Type float

Read Only Yes

LengthDiff

This property reports the volute diffuser axial length.

Type Quantity

Read Only Yes

LengthDiffUser

This property specifies the value of the volute diffuser axial length. This is valid when UserLengthDiff
is set to true.

Type Quantity

Read Only No

MechEff

This property reports the mechanical efficiency of the impeller.

Type float

Read Only Yes

MechEffUser

This property specifies the impeller mechanical efficiency. This is valid when the EfficiencyOption is set
to 'Hydraulic', 'Volumetric' or 'Pump'.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1008 of ANSYS, Inc. and its subsidiaries and affiliates.
Type float

Read Only No

MerVelRatio

This property specifies the gradient of the velocity profile from hub to shroud at the impeller leading
edge. The gradient is set using the ratio of the meridional velocity at the shroud leading edge radius
to that at the average leading edge radius.

Type float

Read Only No

MinDiamFactor

This property specifies the shaft minimum diameter factor. This is a 'factor of safety' applied to the shaft
minimum diameter as calculated from the maximum allowable shear stress of the shaft.

Type float

Read Only No

NPSHr

This property reports the net positive suction head required (NPSHr) of the impeller.

Type Quantity

Read Only Yes

Nq

This property reports the specific speed of the impeller using the European units system.

Type float

Read Only Yes

Ns

This property reports the specific speed of the impeller using the US units system.

Type float

Read Only Yes

Nss

This property reports the non-dimensional suction specific speed of the impeller.

Type float

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1009
TurboSystems

NumVanes

This property specifies the number of impeller vanes.

Type int

Read Only No

OmegaS

This property reports the non-dimensional specific speed of the impeller.

Type float

Read Only Yes

PowShaft

This property reports the shaft power of the impeller.

Type Quantity

Read Only Yes

PumpEff

This property reports the overall efficiency of the impeller. This is the product of the hydraulic, volumetric
and mechanical efficiencies.

Type float

Read Only Yes

PumpEffUser

This property specifies the impeller overall efficiency. This is valid when the EfficiencyOption is set to
'Hydraulic', 'Volumetric' or 'Mechanical'.

Type float

Read Only No

R3

This property reports the volute base-circle radius. This is defined as the distance from the centreline
to the volute tongue.

Type Quantity

Read Only Yes

Rake

This property reports the lean angle at the impeller trailing edge (rake angle). Note that although this
is also specified as an input property, the process to achieve the rake angle is iterative and may not

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1010 of ANSYS, Inc. and its subsidiaries and affiliates.
always be achievable. In this situation there will be a difference between this value and that specified
by the input property.

Type Quantity

Read Only Yes

RakeUser

This property specifies the blade lean angle at the impeller trailing edge (rake angle)

Type Quantity

Read Only No

Rho

This property specifies the density of the working fluid.

Type Quantity

Read Only No

RMajor

This property reports a list of the major radii of the elliptic volute cross sections. This is valid when Vo-
luteStyleOpt is 'Elliptic'.

Type List<Quantity>

Read Only Yes

RMinor

This property reports a list of the minor radii of the elliptic volute cross sections. This is valid when Vo-
luteStyleOpt is 'Elliptic'.

Type List<Quantity>

Read Only Yes

ShaftDiamRatio

This property specifies the shaft diameter ratio. This is defined as the ratio of the hub diameter to the
shaft diameter. It is used to determine the hub diameter from the shaft diameter and size of the impeller
fittings used to fix the impeller to the shaft.

Type float

Read Only No

ShrBeta1Opt

This property specifies how the impeller leadng edge blade angle at the shroud is set. With this option
set to 'Incidence' the blade angle is calculated from the specified incidence, otherwise the blade angle
is specified directly.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1011
TurboSystems

Available options:

Incidence
User

Type ShrLEBetaType

Read Only No

SlipRatio

This property reports the ratio of the slip velocity to the blade speed at the impeller trailing edge.

Type float

Read Only Yes

Speed

This property specifies the rotational speed of the pump impeller.

Type Quantity

Read Only No

Theta2

This property reports the angle of inclination to the horizontal of the impeller trailing edge, when viewed
in the meridional plane.

Type Quantity

Read Only Yes

ThetaCR

This property specifies the volute casing rotation angle. This is defined as the angle between the vertical
line and the tongue location when viewing the central section through the volute.

Type Quantity

Read Only No

ThetaDiff

This property reports the volute diffuser cone angle.

This is defined as the angle between the sloping sides of a circular based conic frustum, with the same
inlet area, exit area and axial length as the volute diffuser.

Type Quantity

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1012 of ANSYS, Inc. and its subsidiaries and affiliates.
Thk

This property reports the impeller vane thickness.

Type Quantity

Read Only Yes

ThkRatio

This property specifies the ratio of the impeller vane thickness to the tip diameter. It is used in order
to specify the impeller vane thickness in a non-dimensional manner.

Type float

Read Only No

TongueClear

This property reports the volute tongue clearance. This is defined as the volute base-circle radius minus
the impeller tip radius.

Type Quantity

Read Only Yes

TongueThk

This property reports the thickness of the volute tongue ie. the tongue diameter at the cutwater.

Type Quantity

Read Only Yes

U1

This property reports the blade speed at the impeller leading edge meanline section.

Type Quantity

Read Only Yes

U1Hub

This property reports the blade speed at the impeller leading edge hub section.

Type Quantity

Read Only Yes

U1Shr

This property reports the blade speed at the impeller leading edge shroud section.

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1013
TurboSystems

Read Only Yes

U2

This property reports the blade speed at the impeller trailing edge (tip speed).

Type Quantity

Read Only Yes

UserDiamDiff

This property specifies that the volute diffuser exit diameter is to be defined by the user, rather than
calculated automatically.

Type bool

Read Only No

UserLengthDiff

This property specifies that the volute diffuser axial length is to be defined by the user, rather than
calculated automatically.

Type bool

Read Only No

VolA

This property reports a list of the volute cross sectional areas from cutwater to throat.

Type List<Quantity>

Read Only Yes

VolEff

This property reports the volumetric efficiency of the impeller.

Type float

Read Only Yes

VolEffUser

This property specifies the impeller volumetric efficiency. This is valid when the EfficiencyOption is set
to 'Hydraulic', 'Mechanical' or 'Pump'.

Type float

Read Only No

VolFlow

This property specifies the design point volume flow rate delivered by the pump.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1014 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Quantity

Read Only No

VolHeight

This property reports a list of the height of the rectangular volute cross sections. This is valid when
VoluteStyleOpt is 'Rectangular'.

Type List<Quantity>

Read Only Yes

VolR

This property reports a list of the radii of the centroids of the volute cross sections.

Type List<Quantity>

Read Only Yes

VolRouter

This property reports a list of the outer radii of the volute cross sections.

Type List<Quantity>

Read Only Yes

VoluteStyleOpt

This property specifies the volute cross section shape.

Available options:

Elliptic
Rectangular

Type VoluteType

Read Only No

VolWidth

This property reports a list of the width of the rectangular volute cross sections. This is valid when Vo-
luteStyleOpt is 'Rectangular'.

Type List<Quantity>

Read Only Yes

W1

This property reports the relative flow velocity at the impeller leading edge meanline section.

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1015
TurboSystems

Read Only Yes

W1Hub

This property reports the relative flow velocity at the impeller leading edge hub section.

Type Quantity

Read Only Yes

W1Shr

This property reports the relative flow velocity at the impeller leading edge shroud section.

Type Quantity

Read Only Yes

W2

This property reports the relative flow velocity at the impeller trailing edge.

Type Quantity

Read Only Yes

Vista RTD
This container holds Analysis data for an instance of Vista RTD.

Methods
CreateBladeDesign
This command class creates a new BladeGen model. An up-to-date BladeGen cell appears on the project
schematic containing the new model.

Return Container representing the BladeGen cell.

Type DataContainerReference

CreateGeometry
This command class creates a new BladeEditor model. An up-to-date Geometry cell appears on the
project schematic containing the new model.

Return Container representing the Geometry cell.

Type DataContainerReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1016 of ANSYS, Inc. and its subsidiaries and affiliates.
CreateThroughflow
This command class creates a new throughflow system. The system, comprising Geometry, Setup,
Solution and Results cells, is created on the project schematic and is updated performing the throughflow
analysis automatically.

Optional Arguments

UseBladegen Indicates whether to use a Bladegen cell or a BladeEditor(Geometry) cell

Type bool

Default Value False

Edit
This command class launches the Vista popup GUI.

GetVistaRTDBladeDesignProperties
This query takes a container reference and returns the Data Entity which contains user settings and
properties for the VistaRTD Blade Design container.

Return Reference to the requested Data Entity

Type DataReference

ImportBladeGen
This command imports Vista data into the Blade Design cell from an existing BladeGen file. If no appro-
priate Vista data is found in the specified BladeGen file, an error message is generated.

template1 = GetTemplate(TemplateName="VistaCPD")
system1 = template1.CreateSystem()
bladeDesign1 = system1.GetContainer(ComponentName="Blade Design")
bladeDesign1.Import(FilePath="myfilepath/pump.bgd")

Required Arguments

FileName Name, and path, of the BladeGen file to be imported.

Type string

Data Entities
VistaRTDBladeDesign
This data entity provides access to the properties which define the VistaRTD project. This includes both
the input and the results properties.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1017
TurboSystems

Properties
AFR

This property specifies the air/fuel ratio of the working fluid. This is only available when using the AFR
option for GasProps.

Type float

Read Only No

Alpha2

This property reports the absolute flow angle at the impeller inlet.

Type Quantity

Read Only Yes

Alpha2User

This property specifies the absolute flow angle at the impeller leading edge. Note that this is not
available when the InletOption is set to 'Calculated'.

Type Quantity

Read Only No

Alpha3

This property reports the absolute flow angle at the impeller exit station.

Type Quantity

Read Only Yes

Alpha3User

This property specifies the absolute flow angle at the impeller trailing edge.

Type Quantity

Read Only No

Beta2

This property reports the relative flow angle at the impeller inlet.

Type Quantity

Read Only Yes

Beta2User

This property specifies the relative flow angle at the impeller leading edge. Note that this is not available
when the InletOption is set to 'Calculated'.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1018 of ANSYS, Inc. and its subsidiaries and affiliates.
Type Quantity

Read Only No

Beta3

This property reports the meanline section relative flow angle at the impeller exit station.

Type Quantity

Read Only Yes

Beta3hub

This property reports the hub section relative flow angle at the impeller exit station.

Type Quantity

Read Only Yes

Beta3shroud

This property reports the shroud section relative flow angle at the impeller exit station.

Type Quantity

Read Only Yes

Beta3User

This property specifies the relative flow angle at the impeller trailing edge.

Type Quantity

Read Only No

BMunitsOption

This property specifies the units used when creating a new BladeGen/BladeEditor model. Note that this
is independent of the units used in the VistaRTD popup GUI.

Available options:

mm
cm
inches
ft
m

Type BMunitsType

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1019
TurboSystems

ClearanceOption

This property specifies impeller tip clearance is specified. 'Ratio' indicates that the tip clearance is specified
as a fraction of the tip width 'User' specifies that the clearance will be defined directly by the user.

Available options:

Ratio
User

Type ClearanceType

Read Only No

ClearLoss

This property reports the proportion of energy loss attributed to the clearances between rotating and
stationary components. Note this is only available when using the 'Correlation' for the efficiency calcu-
lation method, EtaOpt.

Type float

Read Only Yes

ClearRatioUser

This property specifies the ratio of the impeller tip clearance to the tip width. Note that this is only
available when ClearanceOption is set to 'Ratio'.

Type float

Read Only No

ClearUser

This property specifies the value of the impeller tip clearance. Note that this is only available when
ClearanceOption is set to 'User'.

Type Quantity

Read Only No

CorrelationOption

This property specifies the correlation used to calculate the stage efficiency. Note that this is only
available when the EtaOption is set to 'Correlation'.

Available options:

Suhrmann
Baines

Type EtaCorrelType

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1020 of ANSYS, Inc. and its subsidiaries and affiliates.
CpMean

This property reports the average specific heat capacity at constant pressure for the turbine stage.

Type Quantity

Read Only Yes

CpUser

This property specifies the specific heat capacity at constant pressure, Cp, of the working fluid. This is
only available when using the Fixed option for GasProps.

Type Quantity

Read Only No

D2

This property reports the impeller inlet diameter.

Type Quantity

Read Only Yes

D3hub

This property reports the impeller exit hub diameter.

Type Quantity

Read Only Yes

D3shroud

This property reports the impeller exit shroud diameter.

Type Quantity

Read Only Yes

DiameterRatio

This property reports the ratio of the impeller inlet diameter to the meanline exit diameter.

Type float

Read Only Yes

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1021
TurboSystems

Read Only No

EtaImpTS

This property reports the total-to-static impeller efficiency.

Type float

Read Only Yes

EtaImpTT

This property reports the total-to-total impeller efficiency.

Type float

Read Only Yes

EtaNozzle

This property specifies the value of the total-to-static nozzle efficiency. The term 'nozzle' here refers to
the geometry upstream of the impeller used to control the inlet flow angle. This may be either bladed
or unbladed, eg. a volute. A specified nozzle efficiency of 1.0 implies no pressure loss across the nozzle
and consequently the nozzle is neglected from the calculation.

Type float

Read Only No

EtaOption

This property specifies whether to use a correlation to automatically calculate the turbine stage efficiency,
or to use a user-defined efficiency.

Available options:

User
Correlation

template1 = GetTemplate(TemplateName="VistaRTD")
system1 = template1.CreateSystem()
bladeDesign1 = system1.GetContainer(ComponentName="Blade Design")
vistaRTDProperties1 = bladeDesign1.GetVistaRTDBladeDesignProperties()
vistaRTDProperties1.EtaOption = "Correlation"

Type EtaType

Read Only No

EtaStageTS

This property reports the total-to-static stage efficiency.

Type float

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1022 of ANSYS, Inc. and its subsidiaries and affiliates.
EtaStageTT

This property reports the total-to-total stage efficiency.

Type float

Read Only Yes

EtaUser

This property specifies the value of the total-to-total turbine stage efficiency. Note that this entry is
only available when the EtaOption is set to 'User'.

Type float

Read Only No

ExitAngle

This property specifies the flow angle at the impeller exit. This will either be an absolute or relative
value depending on the 'ExitOption'.

Type Quantity

Read Only No

ExitLoss

This property reports the proportion of energy loss attributed to the exhaust. Note this is only available
when using the 'Correlation' for the efficiency calculation method, EtaOpt.

Type float

Read Only Yes

ExitOption

This property specifies the ExitAngle type.

Available options:

Absolute
Relative

Type ExitAngleType

Read Only No

ExpRatio

This property specifies the design point total-to-total expansion ratio, P01/P03, for the turbine stage.

Type float

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1023
TurboSystems

ExpRatioTs

This property reports the total to static expansion ratio for the turbine stage (P01/P3).

Type float

Read Only Yes

FricLoss

This property reports the proportion of energy loss attributed to friction. Note this is only available
when using the 'Correlation' for the efficiency calculation method, EtaOpt.

Type float

Read Only Yes

GammaMean

This property reports the average ratio of specific heats (gamma) for the turbine stage.

Type float

Read Only Yes

GasProps

This property specifies the method used to calculate the properties of the working fluid.

Available options:

Air
AFR
Fixed

template1 = GetTemplate(TemplateName="VistaRTD")
system1 = template1.CreateSystem()
bladeDesign1 = system1.GetContainer(ComponentName="Blade Design")
vistaRTDProperties1 = bladeDesign1.GetVistaRTDBladeDesignProperties()
vistaRTDProperties1.GasProps = "AFR"

Type GasPropType

Read Only No

HubRatio

This property specifies the ratio of the impeller exit radius at the hub to the impeller inlet radius (tip
radius). This enables the hub exit radius to be controlled in a non-dimensional way.

Type float

Read Only No

ImpellerLength

This property reports the ratio of the impeller axial length to the impeller tip diameter.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1024 of ANSYS, Inc. and its subsidiaries and affiliates.
Type float

Read Only Yes

ImpellerLengthOption

This property specifies whether the impeller length ratio is calculated automatically, or specified by the
user.

Available options:

Automatic
User

Type ImpellerLengthType

Read Only No

ImpellerLengthUser

This property specifies the ratio of the impeller axial length to the impeller tip diameter. This enables
the impeller axial length to be controlled in a non-dimensional way.

Type float

Read Only No

ImpellerLengthUserOpt

This property specifies whether the impeller axial length ratio will be defined by the user.

Type bool

Read Only No

ImpellerNumber

This property specifies the number of impeller vanes.

Type int

Read Only No

ImpellerThickness

This property specifies the average vane thickesses at the impeller exit.

Type Quantity

Read Only No

IncLoss

This property reports the proportion of energy loss attributed to the incidence at the leading edge.
Note this is only available when using the 'Correlation' for the efficiency calculation method, EtaOpt.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1025
TurboSystems

Type float

Read Only Yes

InletAngle

OBSOLETE PROPERTY RETAINED FOR BACKWARDS COMPATIBILITY IN THE POST MIGRATION STEP

This property specifies the flow angle at the impeller inlet. This will either be specified as an absolute
or relative value depending on the 'InletOption'.

Type Quantity

Read Only No

InletOption

This property specifies the InletAngle type.

Available options:

Absolute
Relative
Calculated. ****** OBSOLETE OPTION PLEASE USE ABSOLUTE OR RELATIVE ********

Type InletAngleType

Read Only No

Loading

This property reports the basic loading for the turbine stage (delH/U^2).

Type float

Read Only Yes

LoadLoss

This property reports the proportion of energy loss attributed to loading. Note this is only available
when using the 'Correlation' for the efficiency calculation method, EtaOpt.

Type float

Read Only Yes

Mach2

This property reports the absolute Mach number at the impeller inlet.

Type float

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1026 of ANSYS, Inc. and its subsidiaries and affiliates.
Mach3rms

This property reports the meanline section absolute Mach number at the impeller exit station.

Type float

Read Only Yes

MachRel2

This property reports the relative Mach number at the impeller inlet.

Type float

Read Only Yes

MachRel3shroud

This property reports the shroud section relative Mach number at the impeller exit station.

Type float

Read Only Yes

MassFlow

This property specifies the design point mass flow rate passing through the turbine stage.

Type Quantity

Read Only No

MrootToverP

This property reports the characteristic flow function for the design point (M x SQRT(T) / P).

Type float

Read Only Yes

NozChkRatio

This property reports the choke ratio for the nozzle.

Type float

Read Only Yes

NozExitDiameter

This property reports the nozzle exit diameter.

Type Quantity

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1027
TurboSystems

NozThtArea

This property reports the throat area of the nozzle.

Type Quantity

Read Only Yes

NozVlessRatio

This property reports the ratio of the 'vaneless' nozzle area to the impeller inlet radius. Note that the
nozzle area used here neglects the vane thickness, hence the 'vaneless' prefix.

Type Quantity

Read Only Yes

Ns

This property reports the specific speed of the impeller.

Type float

Read Only Yes

Omega

This property specifies the design point rotational speed of the impeller.

Type Quantity

Read Only No

OvrChkRatio

This property reports the overall choke ratio (mass flow/choke flow) for the turbine stage.

Type float

Read Only Yes

P02

This property reports the total pressure at impeller inlet.

Type Quantity

Read Only Yes

P03

This property reports the total pressure at impeller exit.

Type Quantity

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1028 of ANSYS, Inc. and its subsidiaries and affiliates.
P2

This property reports the static pressure at impeller inlet.

Type Quantity

Read Only Yes

P3

This property reports the static pressure at impeller exit.

Type Quantity

Read Only Yes

Power

This property reports the aerodynamic power generated by the turbine, neglecting mechanical losses.

Type Quantity

Read Only Yes

Reaction

This property reports the degree of reaction for the turbine stage, (T2 - T3)/(T01 - T03).

Type float

Read Only Yes

RelVelRatShroud

This property reports the ratio of the impeller exit relative velocity at the shroud (W3shr) to the impeller
inlet relative velocity (W2).

Type float

Read Only Yes

RUser

This property specifies the specific gas constant, R, of the working fluid. This is only available when using
the Fixed option for GasProps.

Type Quantity

Read Only No

ShroudRatio

This property specifies the ratio of the impeller exit radius at the shroud to the impeller inlet radius (tip
radius). This enables the shroud exit radius to be controlled in a non-dimensional way.

Type float

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1029
TurboSystems

Read Only No

SpanwiseDistributionOption

This property specifies the spanwise distribution used when exporting the impeller blade.

Available options:

General
Radial

Type SpanwiseDistributionType

Read Only No

SpeedRatio

This property specifies the blade speed ratio, U2/C0, of the impeller, where U2 is the impeller tip speed
and C0 is the spouting velocity. In this definition the spouting velocity is calculated from the total-to-
total isentropic temperature drop.

Type float

Read Only No

StagPressure

This property specifies the design point stagnation pressure, P01, at the inlet to the turbine stage. Note
that this is defined upstream of the nozzle guide vane ahead of the impeller.

Type Quantity

Read Only No

StagTemp

This property specifies the design point stagnation temperature, T01, at the inlet to the turbine stage.
Note that this is defined upstream of the nozzle guide vane ahead of the impeller.

Type Quantity

Read Only No

SurfaceFinish

This property specifies the surface finish of the impeller. The surface roughness has a secondary effect
on the calculated efficiency.

Available options:

Machined
Cast

Type RoughnessType

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1030 of ANSYS, Inc. and its subsidiaries and affiliates.
T02

This property reports the total temperature at impeller inlet.

Type Quantity

Read Only Yes

T03

This property reports the total temperature at impeller exit.

Type Quantity

Read Only Yes

T2

This property reports the static temperature at impeller inlet.

Type Quantity

Read Only Yes

T3

This property reports the static temperature at impeller exit.

Type Quantity

Read Only Yes

TipWidth

This property reports the impeller inlet tip width.

Type Quantity

Read Only Yes

TotalLoss

This property reports the sum of the friction, loading, clearance and exit losses. It is equal to one minus
the total-to-total stage efficiency. Note this is only available when using the 'Correlation' for the efficiency
calculation method, EtaOpt.

Total losses

Type float

Read Only Yes

U2

This property reports the blade speed at the impeller inlet (tip speed)

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1031
TurboSystems

Type Quantity

Read Only Yes

U3shroud

This property reports the shroud section blade speed (tip speed) at the impeller exit station.

Type Quantity

Read Only Yes

V2

This property reports the absolute velocity at the impeller inlet.

Type Quantity

Read Only Yes

V3rms

This property reports the meanline section absolute velocity at the impeller exit station.

Type Quantity

Read Only Yes

Vax3rms

This property reports the meanline section axial velocity at the impeller exit station.

Type Quantity

Read Only Yes

VelRatio1

This property reports the flow coefficient at impeller exit. This is the ratio of the average axial velocity
at the impeller exit (Vax3) to the impeller tip speed (U2).

Type float

Read Only Yes

VelRatio2

This property reports the blade speed ratio, U2/C0, of the impeller, where U2 is the impeller tip speed
and C0 is the spouting velocity. In this definition the spouting velocity is calculated from the total-to-
static isentropic temperature drop.

Type float

Read Only Yes

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1032 of ANSYS, Inc. and its subsidiaries and affiliates.
Vr2

This property reports the radial velocity at the impeller inlet.

Type Quantity

Read Only Yes

Vw2

This property reports the swirl (tangential) velocity at the impeller inlet

Type Quantity

Read Only Yes

Vw3rms

This property reports the meanline section swirl velocity at the impeller exit station.

Type Quantity

Read Only Yes

W2

This property reports the relative velocity at the impeller inlet.

Type Quantity

Read Only Yes

W3shroud

This property reports the shroud section relative velocity at the impeller exit station.

Type Quantity

Read Only Yes

ZeroBetaInlet

Specifies whether or not the relative flow angle at the impeller inlet is zero. Note that a zero inlet angle
is a 'special case' where the exit angles are calculated rather than specified.

Type bool

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1033
TurboSystems

Vista TF Setup
This container holds Setup data for an instance of Vista TF.

Methods
GetSetupEntity
This query is used to retrieve the Vista TF Setup data entity for the specified container.

Return A reference to the requested data entity.

Type DataReference

ImportAeroTemplate
Imports throughflow aerodynamic data into the Vista TF Setup from an existing throughflow aero
template (.aert) file.

Required Arguments

FilePath Path of the file to be imported.

Type string

ImportControlTemplate
Imports throughflow control data into the Vista TF Setup from an existing throughflow control template
(.cont) file.

Required Arguments

FilePath Path of the file to be imported.

Type string

ImportCorrelationsTemplate
Imports throughflow correlations data into the Vista TF Setup from an existing throughflow correlations
template (.cort) file.

Required Arguments

FilePath Path of the file to be imported.

Type string

ImportCustomRealGas
Imports custom real gas data into the Vista TF Setup from a real gas file (.rgp)

Required Arguments

FilePath Path of the file to be imported.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1034 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

ImportGeometry
Imports throughflow geometry data into the Vista TF Setup from an existing throughflow geometry
(.geo) file.

Required Arguments

FilePath Path of the file to be imported.

Type string

Data Entities
VistaTFSetup
This data entity represents a Vista TF project definition on a geometry.

Properties
Acentric

User input, acentric factor

Type float

Read Only No

ConditionsFromUpstream

Flag to choose whether to update operating conditions from upstream cell or not

Type bool

Read Only No

CpCoeff

User input: Cp expression coefficients

Type List<double>

Read Only No

CpGas

Specifies the gas specific heat at constant pressure when FluidOption = IdealGas.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1035
TurboSystems

CpMax

User input: Cp expression, max temperature

Type float

Read Only No

CpMin

User input: Cp expression, min temperature

Type float

Read Only No

CriticalPressure

User input, critical pressure

Type Quantity

Read Only No

CriticalTemp

User input, critical temperature

Type Quantity

Read Only No

CriticalVol

User input, critical volume

Type Quantity

Read Only No

CustomRealGasFilename

The filename for the specified custom real gas file. Only used where the custom real gas option is spe-
cified.

Type string

Read Only No

CwFluid

Specifies the liquid specific heat when FluidOption = Liquid.

Type Quantity

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1036 of ANSYS, Inc. and its subsidiaries and affiliates.
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

DynamicViscosity

Specifies the fluid dynamic viscosity or machine Reynolds number.

Available options:

A value less than 1 [N s m^-2] (or equivalent value in other units) is interpreted as the dynamic
viscosity. Note that the value must be greater than 0.0000001 [N s m^-2].
A value of 0 causes Vista TF to calculate the dynamic viscosity from an inbuilt equation for
dynamic viscosity based on Sutherland's law and the Inlet Total Temperature. This works only
for an ideal gas.
A value greater than 1 [N s m^-2] (or equivalent value in other units) is interpreted as the
Reynolds number, in which case Vista TF calculates the dynamic viscosity using this Reynolds
number, the Reference Diameter, the Machine Rotational Speed, and the fluid density.

Type Quantity

Read Only No

FlowOption

Specifies the types of boundary conditions.

Available options:

MassFlow Specify the mass flow rate and the inlet total
pressure and total temperature conditions.
PressureRatio Specify the estimated mass flow rate and the
total to static pressure ratio on the mean
streamline.
PressureDifference Specify the estimated mass flow rate and the
total to static pressure difference on the mean
streamline.

Type FlowType

Read Only No

FluidOption

Specifies the type of fluid.

Available options:

IdealGas For compressible flows with ideal gas proper-

ties.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1037
TurboSystems

RealGas For compressible flow with real gas properties

Liquid For incompressible flows.

Type FluidType

Read Only No

GammaGas

Specifies the gas specific heat ratio when FluidOption = IdealGas.

Type float

Read Only No

InitialCmUref

Specifies the initial guess for the meridional velocity divided by a characteristic velocity, where the latter
is half the Reference Diameter multiplied by the Machine Rotational Speed. For more information, see
the description for cm_start in Specification of the Control Data File (*.con) in the Vista TF Reference
Guide.

Type float

Read Only No

InletPt

Specifies the inlet total pressure.

Type Quantity

Read Only No

InletSwirlAngle

Specifies the inlet swirl angle, which is from the axial direction and positive in the direction of rotation.

Type Quantity

Read Only No

InletTt

Specifies the inlet total temperature.

Type Quantity

Read Only No

MachineTypeOption

Specifies the type of machine that will be analyzed. This property specifies which template files are
used and which report is used for the results. This property is only available if the geometry data is
imported rather than transferred from BladeEditor.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1038 of ANSYS, Inc. and its subsidiaries and affiliates.
Available options:

Pump
AxialCompressor
CentrifugalCompressor
Fan
AxialTurbine
RadialTurbine
HydraulicTurbine
Unknown
Other (Obsolete use Unknown)

Type MachineType

Read Only No

MassFlow

Specifies the mass flow rate when FlowOption = MassFlow or the estimated mass flow rate when Flow-
Option = PressureRatio or PressureDifference.

Type Quantity

Read Only No

MaxIterations

Specifies the number of calculating streamlines used in the solver.

Type int

Read Only No

NumBladeRows

Specifies the number of blade rows solved in the analysis. This property is only available if the geometry
data is imported rather than transferred from BladeEditor, and it is only used by the report template
for the Results.

Type int

Read Only No

NumStreamlines

Specifies the number of calculating streamlines used in the solver.

Type int

Read Only No

PolytropicEfficiency

Specifies the small scale polytropic efficiency for the machine, and is used to calculate the losses.

Type float

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1039
TurboSystems

Read Only No

PressureDifference

Specifies the total to static pressure difference on the mean streamline when FlowOption = PressureDif-
ference.

Type Quantity

Read Only No

PressureRatio

Specifies the total to static pressure ratio on the mean streamline when FlowOption = PressureRatio.

Type float

Read Only No

RealGasOption

Specifies which real gas is used

Type RealGas

Read Only No

RefDiameter

Specifies the reference diameter for the definition of the flow coefficient.

Type Quantity

Read Only No

RefDiameterOption

Specifies whether to have Vista TF calculate the reference diameter automatically or to use a user defined
value.

Available options:

Automatic Reference diameter is calculated using the

first rotating component.
User defined Reference diameter is specified by the user.

Type RefDiameterType

Read Only No

RGas

User input, specific gas constant

Type Quantity

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1040 of ANSYS, Inc. and its subsidiaries and affiliates.
Read Only No

RhoFluid

Specifies the fluid density when FluidOption = Liquid.

Type Quantity

Read Only No

RotationalDirection

Specifies the positive direction of machine rotation about the Z-axis.

Available options:

RightHanded Positive rotation is clockwise about the Z-axis.

LeftHanded Positive rotation is counterclockwise about
the Z-axis.

Type RotationType

Read Only No

RotationalSpeed

The specified machine rotational speed.

Type Quantity

Read Only No

Vista TF Solution
This container holds Solution data for an instance of Vista TF.

Data Entities
SolutionOptionsDataEntity
This data entity holds the Workbench properties for a Vista TF solution component.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1041
TurboSystems

ExpressionPrefix

Specifies the name that CFD-Post will prepend all Vista TF system

This field will be populated either on the first solve of this container, or during the duplicate operation,
where it will be copied over from the duplicated container.

Type string

Read Only No

VistaTFSolution
This data entity has no user modifiable properties.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1042 of ANSYS, Inc. and its subsidiaries and affiliates.
Units

Units
This container holds the project Unit Systems and unit settings.

Data Entities
Quantity
Holds the unit definition for a specific quantity within a unit system.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsSuppressed

True if this quantity is suppressed in the unit system.

Type bool

Read Only No

QuantityName

The name of the quantity.

Type string

Read Only No

Unit

The unit for the quantity.

Type string

Read Only No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1043
Units

UnitSystem
Holds the definition of a unit system within the project.

Properties
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data
entities but is used only in those entities that present a label in the user interface.

Type string

Read Only No

IsDefault

True if this is the current default unit system.

Type bool

Read Only No

IsProjectUnitSystem

True if this is the current project unit system.

Type bool

Read Only No

Quantities

The set of quantity entities that define the unit system.

Type DataReferenceSet

Read Only Yes

UnitSystemName

The internal name of the unit system.

Type string

Read Only Yes

Methods
Export

Exports unit system information into a Units XML file.

Required Arguments

FilePath The full path and name of the file to be created.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1044 of ANSYS, Inc. and its subsidiaries and affiliates.
Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1045
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1046 of ANSYS, Inc. and its subsidiaries and affiliates.
Namespaced Commands

Ansoft
This namespace holds top-level commands and queries related to Ansoft.

AnalyzeDesignPointsInDesktop
Sends all the input parameters associated with the supplied system argument for analysis in the associ-
ated Ansoft product and solves for them. The designs points solved for depend on the scope argument.

Required Arguments

DesignPointScope This defines the collection of design points that will be analyzed.

Type EDesignPointScope

System The system whose associated design (and project) is to be analyzed/solved.

Type DataReference

GetProductExePath
Query to get the executable path assoociated with any AnsysEDT/Ansoft product integrated into
Workbench

Return The fully qualified executable path for the named Ansoft product. This
will be empty if the name supplied is not a recognized Ansoft exe name.

Type string

Required Arguments

Name The product name of the ansoft product. Case insensitive and must be one of the names listed in the
Tools/Options/Electromagnetics or "ansysedt".

Type string

CloseAllEditors
Closes all open editors associated with Ansoft systems on the workbench schematic

EditSystem
Edits the design associated with the system in an instance of the editor. If the system does not have
any associated design, a new design is created/initialized for the system and that new design is opened
for edit.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1047
Namespaced Commands

Required Arguments

System The system whose design is to be edited.

Type DataReference

ExportDesignPointsToDesktop
Exports the values of all the input paramters of the supplied System for all the design points covdred
by the supplied scope. The resulting table of values will be exported to the selected DXSetup's table
in desktop.

Required Arguments

DesignPointScope The collection of design points for which the input parameter values of the supplied
system will be exported.

Type EDesignPointScope

System The system whose parameters will be considered for export.

Type DataReference

ForceSolutionIntoUpdateRequiredState
Force the specified container's component into the "UpdateRequired" or Lightning blot state to allow
the associated editor to update its solution. This is primarily needed to incorporate feedback provided
from downstream connected systems in a pseudo two-way multiphysics silumation.

Required Arguments

System The system whose solution status is to be modified.

Type DataReference

Optional Arguments

InvalidateAllDesignPoints Whether this should invalidate all design points or just the current one.
Default is true: invalidate all design points.

Type bool

Default Value True

GetDesign
Given an Ansoft system, obtain a proxy (IDispatch dynamic object) to the script/COM object corresponding
to the design associated with the system. This will be more-or-less equivalent to the following in Desktop
"oDesktop.GetActiveProject().GetActiveDesign()"

Return The IDispatch wrapper representing the design script/IDispatch object.

Type Object

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1048 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

System The ansoft system for which we want the Design script/IDispatch object.

Type DataReference

GetDesktop
Given an Ansoft system, obtain a proxy (IDispatch dynamic object) to the script/COM object corresponding
to the Desktop scripting objectdesign associated with the system. This will be more-or-less equivalent
to the "oDesktop" scripting object in Desktop's CommandWindow

Return The IDispatch wrapper representing oDesktop script/IDispatch object.

Type Object

Required Arguments

System The ansoft system for which we want the Desktop script/IDispatch object.

Type DataReference

ImportProjectFile
Import an existing Ansoft project file into workbench. The return value is a dictionary the keys of which
are the systems created for the imported project and the values are the names of said systems.

Return If successfully imported, the return value is a Dictionary mapping the

DataReference of the created system to the name of the design in the
imported project.

Type Dictionary<DataReference, string>

Required Arguments

FilePath Absolute path to the file to import.

Type string

LaunchDesktop
Launches an instance of the editor associated with the System in standalone mode (cannot open
workbench owned Ansoft projects). While the system itself cannot be edited (or even loaded) into the
opened editor, application defaults and options can be set.

Required Arguments

System The system that is used to figure out which editor is to be launched.

Type DataReference

RefreshCurrentDesignPoint
Synchronize Desktop variable values to current design point

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1049
Namespaced Commands

Required Arguments

System The system from which all design/project variables values will be synchronized to corresponding
ones in the editor design.

Type DataReference

EKM
This namespace holds top-level commands and queries related to Engineering Knowledge Manager.

AutoregisterSession
Auto-registers this Workbench session with the Workbench Job Manager object in EKM. This command
is used when EKM starts a Workbench job. The registration details include hostname and port.

ConnectEkmServer
Connect Workbench to an EKM server. To connect to a server in batch mode, there is at least one con-
nection's credential (userName plus password) is saved during WB GUI mode. The only required para-
meter is the server location. Input UserName will be used to compare with saved credential. If no
UserName provided, any of the saved user names will be used.

Required Arguments

Location EKM Server location to be connected

Type string

Optional Arguments

IndividualServer Specify if it's an Individual Server

Type bool

Default Value False

Port Port number for the server, default is 8080

Type long

UserName Specify a user name to the EKM server if needed

Type string

Workspace Workspace you wish to connect to

Type string

Default Value Default

Example
The following example illustrates the connecting to a given EKM server with other optional parameters.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1050 of ANSYS, Inc. and its subsidiaries and affiliates.
 EKM.ConnectEkmServer(Location="auswchiang64", // Required
Workspace="Default", // Optional
Port=8080, // Optional
IndividualServer=False, // This parameter will eventually obsolete since individual s
UserName="root" // Optional
)

GetChangesFromRepository
Get changes of the project from EKM repository.

Optional Arguments

BackupProject Backup current project

Type bool

Default Value False

CheckOut Checkout flag if under version controlled project

Type bool

Default Value False

Example
The following example illustrates the obtaining of project changes from an EKM repository.

EKM.GetChangesFromRepository(BackupProject=False,
Checkout=False)

GetSessionId
A query for getting the unique id of current Workbench session.

Return The property value.

Type string

LaunchWebUi
Launches EKM Desktop.

Required Arguments

ConnectionUrl Url to open in a web browser

Type string

OpenFromRepository
Open an archived project from EKM repository to Workbench. The opened project will also saved in
your local disk with repository info saved in the local project. Once it's opened, user can modify and

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1051
Namespaced Commands

save the project locally, send local changes to repository, and also update local project from repository
if the project is changed in repository.

Required Arguments

ProjectPath Local project path for the repository project to be opened to

Type string

RepositoryPath Remote repository path to be downloaded from EKM repository

Type string

Optional Arguments

CheckOut Should the repository project should be checked out if applicable

Type bool

Default Value False

Example
The following example illustrates the opening of an archive from an EKM Repository to local disk.

EKM.SaveToRepository(RepositoryPath=r"\\path_to_EKM_repository\archived_project.wbpz", // Required
ProjectPath=r"\\local_project_path", // Required
CheckOut=False // Optional, appl
)

RegisterSession
Registers the current Workbench session with EKM so that it can be controlled through EKM Web inter-
face.

Required Arguments

ConnectionName Name of the connection

Type string

SaveToRepository
Save archived project to EKM repository. The project must be saved before calling this command. A
warning will popup if not saved.

Required Arguments

RepositoryFolderPath Remote repository directory path for the archived file to be uploaded in the
repository

Type string

Optional Arguments

CheckOut Check out if placing under version control

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1052 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type bool

Default Value False

Description Whether to include files imported to the project from external locations.

Type string

GetExclusiveControl Access Control

Type bool

Default Value False

IncludeExternalFiles Include result files

Type bool

Default Value True

IncludeResultFiles Include result files

Type bool

Default Value True

PlaceUnderVersionControl Access Control

Type bool

Default Value False

Example
The following example illustrates the saving of an archive to an EKM Repository. It will save the specified
archived project to the specified EKM repository, placing it under source control, and checking it out to
my local machine.

EKM.SaveToRepository(RepositoryFolderPath=r"\\path_to_EKM_repository",
IncludeResultFiles=True,
IncludeExternalFiles=True,
GetExclusiveControle=False,
PlaceUnderVersionControl=False,
CheckOut=False,
Description="My Sample EKM Project Save")

SendChangesToRepository
Save archived project to EKM repository. The project must be saved before calling this command. A
warning will popup if not saved.

Required Arguments

RepositoryPath Remote repository directory path for the project to be sent into repository

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1053
Namespaced Commands

Optional Arguments

Checkin Checkin option if applicable

Type bool

Default Value False

CheckOut CheckOut option if applicable

Type bool

Default Value False

Comments Comments

Type string

IncludeExternalFiles Include result files

Type bool

Default Value True

IncludeResultFiles Include result files

Type bool

Default Value True

ReleaseExclusiveControl Release exclusive control after update if applicable

Type bool

Default Value False

Example
The following example illustrates the sending of project changes to an EKM repository. The specified
archived project will be sent to the specified EKM Repository. The additional arguments specify, in order:
(1) Whether a new EKM project version will be assigned (InExiting). (2) Source control behavior (Checkin-
Option : a value greater than zero will issue a checkin. A value of 2 will check out the project after a suc-
cessful checkin.). (3) Whether to release the exclusive control (lock) upon successful project submission
(ReleaseExclusiveControl).

EKM.SendChangesToRepository(RepositoryPath=r"\\path_to_my_EKM_repository",
InExiting=True,
CheckinOption=0,
ReleaseExclusiveControl=False,
Comments="These are my comments for my changes")

UnregisterSession
Unregisters this Workbench session by deleting all job object(s) created in EKM to control it.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1054 of ANSYS, Inc. and its subsidiaries and affiliates.
UploadToRepository
Save archived project to EKM repository. The project must be saved before calling this command. A
warning will popup if not saved.

Required Arguments

ArchiveFilePath Local file path for the archived project file to be save to repository

Type string

RepositoryFolderPath Remote repository directory path for the archived file to be uploaded in the
repository

Type string

Optional Arguments

CheckOut Check out if placing under version control

Type bool

Default Value False

Description Whether to include files imported to the project from external locations.

Type string

GetExclusiveControl Access Control

Type bool

Default Value False

PlaceUnderVersionControl Access Control

Type bool

Default Value False

Example
The following example illustrates the saving of the specified archive to the specified EKM repository and
updates the timestamp in the specified EKM record file. The additional arguments specify, in order: (1)
Whether to obtain exclusive control for the archive after successful EKM upload (GetExclusiveControl). (2)
Whether to place the uploaded archive under version control (PlaceUnderVersionControl). (3) Whether to
check out the archived project after uploaded to EKM and placing it under version control (Checkout).

EKM.UploadToRepository(ArchiveFilePath=r"C:\Users\anyuser\path_to_my_wbpz_file.wbpz",
RepositoryFolderPath=r"\\path_to_my_EKM_repository",
LocalRepositoryRecordFilePath=r"C:\Users\anyuser\path_to_local_repository_project_re
GetExclusiveControl=True,
PlaceUnderVersionControl=True,
CheckOut=True,
Comments="These are my comments for this update.")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1055
Namespaced Commands

EngData
This namespace holds top-level commands and queries related to Engineering Data.

CreateLibrary
Creates a new Engineering Data library.

Return The created Engineering Data library.

Type DataContainerReference

Required Arguments

Name The name of a new library.

Type string

Optional Arguments

FilePath The target path for a new library.

Type string

OpenLibrary
Opens a library of engineering information so that it can be viewed and if permissions allow, edited.

Return The DataContainerReference for the library that was opened.

Type DataContainerReference

Required Arguments

Source The source of the library.

Type string

Example
This code shows how to open a library from the provided samples.

installDir = r"C:\Program Files\ANSYS Inc\v121"

library1 = EngData.OpenLibrary(
Name="General Materials",
Source=installDir+r"\Addins\EngineeringData\Samples\General_Materials.xml")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1056 of ANSYS, Inc. and its subsidiaries and affiliates.
Extensions
This namespace holds top-level commands and queries related to ACT.

InstallExtension
This command install an extension identified by its filename.

If this extension already exists, the user can force to install the extension by setting the variable "For-
ceInstall" to true.

Required Arguments

ExtensionFileName ExtensionFileName argument containing the file name of the extension.

Type string

Optional Arguments

ForceInstall Indicates whether the extension will be installed even if this extension already exists.

Type bool

Default Value False

Example
To install an extension:

Extensions.InstallExtension(ExtensionFileName=r"c:\my_extensions_repository\my_extension.wbex")

To install an extension and force installation if the extension already exists:

Extensions.InstallExtension(ExtensionFileName=r"c:\my_extensions_repository\my_extension.wbex",ForceInstall

LoadExtension
This command load an installed extension.

Required Arguments

Id Id argument containing the GUID of the extension.

Type string

Optional Arguments

Format Format argument containing the format of the extension (Scripted or Binary).

Type string

Version Version argument containing the version of the extension.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1057
Namespaced Commands

Type string

Example
To load an extension:

Extensions.LoadExtension(Id="7FD4DE83-39D0-4252-859B-2393C67F8EC8")
Extensions.LoadExtension(Id="7FD4DE83-39D0-4252-859B-2393C67F8EC8", Version="1.0")
Extensions.LoadExtension(Id="7FD4DE83-39D0-4252-859B-2393C67F8EC8", Version="1.0", Format="Binary")

UninstallExtension
This command uninstall an extension.

Required Arguments

Id Id argument containing the GUID of the extension.

Type string

Optional Arguments

ForceUninstall Indicates whether the extension will be uninstalled silently.

Type bool

Default Value False

Format Format argument containing the format of the extension (Scripted or Binary).

Type string

Version Version argument containing the version of the extension.

Type string

Example
To uninstall an extension:

Extensions.UninstallExtension(ExtensionFileName=r"c:\my_extensions_repository\my_extension.wbex")

UnloadExtension
This command unload a loaded extension.

Required Arguments

Id Id argument containing the GUID of the extension.

Type string

Optional Arguments

Format Format argument containing the format of the extension (Scripted or Binary).

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1058 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

Version Version argument containing the version of the extension.

Type string

Example
To unload an extension:

Extensions.UnloadExtension(Id="7FD4DE83-39D0-4252-859B-2393C67F8EC8")
Extensions.UnloadExtension(Id="7FD4DE83-39D0-4252-859B-2393C67F8EC8", Version="1.0")
Extensions.UnloadExtension(Id="7FD4DE83-39D0-4252-859B-2393C67F8EC8", Version="1.0", Format="Binary")

Fluent
This namespace holds top-level commands and queries related to Fluent.

FluentStartPolling
No details are provided for this entry.

CfxStartPolling
No details are provided for this entry.

Graphics
This namespace holds top-level commands and queries related to Graphics.

GetAxisContinuous
A query to return an AxisContinuous data reference.

Return A reference to the AxisContinuous data entity.

Type DataReference

Required Arguments

Name The data entity name of the AxisContinuous object to be found.

Type string

GetAxisDiscrete
A query to return an AxisDiscrete data reference.

Return A reference to the AxisDiscrete data entity.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1059
Namespaced Commands

Required Arguments

Name The data entity name of the AxisDiscrete object to be found.

Type string

GetChartXY
A query to return a ChartXY data reference.

Return A reference to the ChartXY data entity.

Type DataReference

Required Arguments

Name The data entity name of the ChartXY object to be found.

Type string

GetChartXYZ
A query to return an ChartXYZ data reference.

Return A reference to the ChartXYZ data entity.

Type DataReference

Required Arguments

Name The data entity name of the ChartXYZ object to be found.

Type string

GetCorrelationMatrix
A query to return a CorrelationMatrix data reference.

Return A reference to the CorrelationMatrix data entity.

Type DataReference

Required Arguments

Name The data entity name of the CorrelationMatrix object to be found.

Type string

GetLegend
A query to return a Legend data reference.

Return A reference to the Legend data entity.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1060 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The data entity name of the Legend object to be found.

Type string

GetMultiAxisChart
A query to return a MultiAxisChart data reference.

Return A reference to the MultiAxisChart data entity.

Type DataReference

Required Arguments

Name The data entity name of the MultiAxisChart object to be found.

Type string

GetPieChart
A query to return a PieChart data reference.

Return A reference to the PieChart data entity.

Type DataReference

Required Arguments

Name The data entity name of the PieChart object to be found.

Type string

GetRenderStyle
A query to return a RenderStyle data reference.

Return A reference to the RenderStyle data entity.

Type DataReference

Required Arguments

Name The data entity name of the RenderStyle object to be found.

Type string

GetVariable
A query to return a Variable data reference.

Return A reference to the Variable data entity.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1061
Namespaced Commands

Required Arguments

Name The data entity name of the Variable object to be found.

Type string

GetVariableXY
A query to return a VariableXY data reference.

Return A reference to the VariableXY data entity.

Type DataReference

Required Arguments

Name The data entity name of the VariableXY object to be found.

Type string

GetVariableXYZ
A query to return a VariableXYZ data reference.

Return A reference to the VariableXYZ data entity.

Type DataReference

Required Arguments

Name The data entity name of the VariableXYZ object to be found.

Type string

Mechanical
This namespace holds top-level commands and queries related to Mechanical.

ImportLegacyDatabase
Imports a legacy database given the filepath

Return A reference to the LegacyDataBaseResumeData object that contains in-

formation about the imported database

Type DataReference

Required Arguments

FilePath Path to legacy database to import.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1062 of ANSYS, Inc. and its subsidiaries and affiliates.
Meshing
This namespace holds top-level commands and queries related to Meshing.

ImportLegacyDatabase
Imports legacy Meshing editor files or CFX mesh files to the Meshing editor from an existing .cmdb file.

Return The data references created by the import process.

Type DataReference

Required Arguments

FilePath The file path to the legacy database to be imported.

Type string

Parameters
This namespace holds top-level commands and queries related to Parameters, Design Points and
DesignXploration.

ClearDesignPointsCache
Clears the Design Points Cache for Design Exploration features. DesignXplorer is using an internal cache
of Design Points to reduce the number of Design Point update operations. This cache is available accross
all of the design exploration systems of a project. This command clears all the data contained in the
cache.

Example
The following example shows how to clear the cache in a project.

ClearDesignPointsCache()

CreateDesignPoint
A command to create a new design point that contains all the parameters, but with their values set to
null.

The design point can be created initially as a "exported" design point, which will allow the files and
associated databases to be reloaded at a later time to view the results of the design point update.

Return A DataReference to the new design point entity.

Type DataReference

Optional Arguments

Exported Indicates that the newly created design point will be exported.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1063
Namespaced Commands

Type bool

Default Value False

Retained Indicates that the newly created design point will be retained.

Type bool

Default Value False

Example
The following example illustrates proper CreateDesignPoint command invocation:

newDP = Parameters.CreateDesignPoint(Exported=True, Retained=False)

CreateParameter
Creates a parameter, optionally associated with a data entity property. The expression and visible name
for the parameters can be optionally specified.

Return A DataReference to the new parameter entity.

Type DataReference

Optional Arguments

DisplayText The display text for the parameter.

Type string

Entity The data model entity that holds the property to be parameterized.

Type DataReference

Expression The initial expression for the parameter.

Type string

IsDirectOutput Indicates if the parameter is a direct output parameter.

Type bool

Default Value False

IsOutput Indicates if the parameter is an output parameter.

Type bool

PropertyName The name of the data model property which the parameter is associated with.

Type string

Example
The following two examples illustrate input and output parameter creation

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1064 of ANSYS, Inc. and its subsidiaries and affiliates.
 myEntity = #Query to obtain your entity on to which parameters will be created.
inptParam1 = Parameters.CreateParameter(Entity=myEntity,
PropertyName="Value",
IsOutput=False,
IsDirectOutput=False,
Expression=None,
DisplayText="My Input Parameter")

outpParam1 = Parameters.CreateParameter(Entity=myEntity,
PropertyName="Value",
IsOutput=True,
IsDirectOutput=True,
Expression=None,
DisplayText="My Output Parameter")

exprParam1 = Parameters.CreateParameter(Entity=None,
PropertyName=None,
IsOutput=False,
IsDirectOutput=False,
Expression="cos(1)",
DisplayText="My Input Expression Parameter")

exprParam2 = Parameters.CreateParameter(Entity=None,
PropertyName=None,
IsOutput=True,
IsDirectOutput=False,
Expression="sin(P1)",
DisplayText="My Output Expression Parameter")

CreateParameterSummaryChart
Creates a multi-axis parallel coordinate chart based on the parameters supplied to the command.

chart1 = Parameters.CreateParameterSummaryChart(Parameters=[])
-or-
parameter1 = Parameters.GetParameter(Name="P1")
parameter2 = Parameters.GetParameter(Name="P2")
parameter3 = Parameters.GetParameter(Name="P3")
chart1 = Parameters.CreateParameterSummaryChart(Parameters=[parameter1, parameter2, parameter3])

Return A data reference that represents the created chart.

Type DataReference

Required Arguments

Parameters The parameters to be included in the parallel coordinate plot.

Type DataReferenceSet

CreateParameterVsParameterChart
Creates a 2-dimensional (x,y) chart that can be used to compare two parameters.

Return A data reference that represents the chart that is created.

Type DataReference

Optional Arguments

XAxisBottom A data reference for the parameter that represents the bottom x-axis.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1065
Namespaced Commands

Type DataReference

XAxisTop A data reference for the parameter that represents the top x-axis.

Type DataReference

YAxisLeft A data reference for the parameter that represents the left y-axis.

Type DataReference

YAxisRight A data reference for the parameter that represents the right y-axis.

Type DataReference

Example
This example illustrates the creation of a chart comparing two parameters.

parameter1 = Parameters.GetParameter(Name="P1")
parameter2 = Parameters.GetParameter(Name="P2")
chart1 = Parameters.CreateParameterVsParameterChart(XAxisBottom=parameter1, YAxisLeft=parameter2)

ExportAllDesignPointsData
Export the data of all design points to a csv file.

Required Arguments

FileName The exported file name.

Type string

Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export all the design points of the project.

Parameters.ExportAllDesignPointsData(FileName="designPoints.csv")

ExportLink
Export the link to design set to a csv file.

Required Arguments

FileName The exported file name.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1066 of ANSYS, Inc. and its subsidiaries and affiliates.
Optional Arguments

AppendMode True to append to an existing csv file, False to overwrite it.

Type bool

Default Value False

Example
The following example shows how the user can export the dictionary of linked point.

Parameters.ExportLinkCommand(FileName="Link.csv")

GetAllDesignPoints
Returns a set of all design points in the project.

Return A data reference set containing all the design points.

Type DataReferenceSet

GetAllSortedDesignPoints
Returns a set of all design points, sorted by their update order in ascending, in the project.

Return A data reference set containing all the sorted design points.

Type DataReferenceSet

GetAllExportedDesignPoints
Retrieves a set of all exported design points.

Return A set of all design points.

Type DataReferenceSet

Optional Arguments

IncludingBaseDesignPoint A flag to determine whether the query to also return the base design
point, which is always retained.

Type bool

Default Value True

GetAllParameters
Returns a set of all parameters in the project.

Return A data reference set containing all the parameters.

Type DataReferenceSet

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1067
Namespaced Commands

GetAllRetainedDesignPoints
Retrieves a set of all retained design points.

Return A set of all design points.

Type DataReferenceSet

Optional Arguments

IncludingBaseDesignPoint A flag to determine whether the query to also return the base design
point, which is always retained.

Type bool

Default Value True

GetAllRetainedDesignPointsWithValidData
Retrieves a set of all retained design points with valid data

Return A set of all design points.

Type DataReferenceSet

Optional Arguments

IncludingBaseDesignPoint A flag to determine whether the query to also return the base design
point, which is always retained.

Type bool

Default Value True

GetDesignPoint
Returns a design point based on the name of the design point.

Return The design point of interest.

Type DataReference

Required Arguments

Name The name of the design point.

Type string

GetNamedExpression
A query to return a reference for a named expression given a name and a scope

Return The named expression of interest.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1068 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

Name The name of the named expression.

Type string

Optional Arguments

Scope The scope in which the named expression is located. Default is global scope.

Type DataReference

GetParameter
A query to return a reference for a parameter given a name and a scope

Return The parameter of interest.

Type DataReference

Required Arguments

Name The name of the parameter.

Type string

Optional Arguments

Scope The scope in which the parameter is located. If this parameter is omitted or is null then the returned
parameter will be global.

Type DataReference

GetParameterSummaryChart
A query to return a reference for a parameter summary chart by name.

Return The parameter chart of interest.

Type DataReference

Required Arguments

Name The name of the chart.

Type string

GetParameterVsParameterChart
A query to return a reference for a parameter vs. parameter chart by name.

Return The parameter chart of interest.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1069
Namespaced Commands

Required Arguments

Name The name of the chart.

Type string

GetScope
Returns a data reference to a named scope

Return the Scope in the Parameter Manager

Type DataReference

Required Arguments

Name The name of the scope entity.

Type string

IsParameterInDesignPointUpToDate
Checks whether a parameter is up to date in a design point.

Return True if the parameter is up to date in the design point.

Type bool

Required Arguments

DesignPoint The design point data reference.

Type DataReference

Parameter The parameter data reference.

Type DataReference

IsParameterUpToDate
Indicates whether a parameter is up to date in a design point.

Return Return if the parameter is up to date in the design point.

Type bool

Required Arguments

Parameter Parameter

Type DataReference

Optional Arguments

DesignPoint Design point

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1070 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataReference

OptimizeUpdateOrder
Optimizes Update Order of Design Points to minimize the number of modifications between two con-
secutives Design Points

SetParameter
Sets the expression of the specified parameter in the base design point.

Required Arguments

Expression The string with the expression for the parameter.

Type string

Parameter The parameter data reference.

Type DataReference

SetUpdateOrderByRow
Sets a value for the update order property of all design points using a sorting method.

Optional Arguments

SortBy The definition of the sorting.

Type List<string>

Project
This namespace holds top-level commands and queries related to the Project, File and Units.

AbandonBackgroundTasks
Abandon all pending background tasks from last update.

AbandonTopLevelBackgroundDesignPointUpdate
Abandon all top-level pending background DP updates if none is running.

AddPropertyTable
This command is used to allow the expression of a property to reference data in the named table. This
is a reference and not a copy, and so if the table is used in the expression, and a change is made on
the referenced table and the change is in the data being referenced the value of the property will be
modified. The command creates table functions in the context of this expression which can be used
with constants, field variables, or another named expression. If the property does not support an expres-
sion an error will occur.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1071
Namespaced Commands

Return An int which corresponds to the Index passed in to the command and
indicates the comand successfully completed.

Type int

Required Arguments

Dependents A List of the column index(es) to use from the Table which correspond to the dependent
variable(s) of the Property. The indexes can be an Integer index or the String name of the
column.

Type List<Object>

Independents A List of the column index(es) to use from the Table for use in the expression and correspond
to the independent variables of the Property. The indexes can be an Integer index or the
String name of the column.

Type List<Object>

Index An integer which uniquely identifies the Table for use in the expression of the Property. In
the expression this table can be accessed via tableIndex(args). The table with an index of
one can be accessed in the expression as table(args) or table1(args).

Type uint

Parent The DataReference of the object which has the Property that the Table should be added
to.

Type DataReference

Property The String which provides the path of the property on the Parent.

Type string

Table The DataReference of the table to add to the Property.

Type DataReference

Optional Arguments

Bounds An enum which describes what will occur when the index is outside of the bounds of the
table. The valid enum values are; Constant, Fit, Zero, and Error. The default is Error.

Type TableInterpolationBeyondBounds

Default Value Error

Interpolation An enum of the type of interpolation to use when accessing data from the table at a
given index. The valid enum values are; None, Linear, Cubic Spline. The default is Linear.

Type TableInterpolation

Default Value Linear

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1072 of ANSYS, Inc. and its subsidiaries and affiliates.
Example

tbl1 = pressure1.CreateTable(Columns=[[“X”, “Length”], [“Y”, “Length”], [“Z”, “Length”], [“Pressure”, “Pres

#
# Use three of the columns from tbl1
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Index=1, Independents=[“X”, “Y”], Dependents=[“Press
# In the table function the x and y refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expresssion=“table1(x, y)”)
#
# Use four of the columns from tbl1
bc1.AddPropertyTable(Property=“Temperature”, Table=tbl1, Index=1, Independents=[“X”, “Y”, “Z”], Dependents=
# In the table function the x, y, and z refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Temperature”, Expression=“table1(x, y, z)”)
#
# Use two of the columns from tbl1
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Index=1, Independents=[“X”], Dependents=[“Pressure”]
# In the table function the x refers to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(x)”)
#
# Use of a constant
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(20)”)

AddSourceToComponentInSystem
Add a connection between two components in the same system.

Required Arguments

SourceComponent A reference to the component providing data.

Type DataReference

TargetComponent A reference to the component receiving data.

Type DataReference

AddTableColumn
AddColumn will add a column at the specified index to the table.

Return The Integer which corresponds to the index of the column which was
newly added to the table.

Type int

Required Arguments

Name The String used to uniquely identify the column (case-sensitive) in this table. If the
value is not unique an error will occur.

Type string

PhysicalQuantity The String for the physical quantity (e.g. Density, Pressure, etc.) used to verify the
data has the correct units.

Type string

Table The DataReference of the table to add this column of data.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1073
Namespaced Commands

Type DataReference

Optional Arguments

Data A List of Strings which specifies the data for this column. The String must be a valid Quantity string
in the form "value [units]".

If the size of the list is smaller than the current number of rows the data will be initialized to
an undefined value. If the size of the List is greater than the current number of rows then an
error will occur.

Type List<Quantity>

Index The Integer index of the location for the newly added column. An index of 0 (zero) will add to the
left-most side of the table. The default is to add the column to the right-most side of the table.

Type int

Example
This example illustrates adding columns to a table.

# NameSpace is the Addin namespace in use (e.g. Study, EngData, etc.) which may have its specific CreateTa
# drParent is the DataReference of an object that has been previously created
table1 = NameSpace.CreateTable(Parent=drParent, Columns=[])
table1.AddRow()
table1.AddRow()
table1.AddRow()
table1.AddColumn("Displacement", "Length", Data=["0 [m]",".001 [m]"])
table1.AddColumn("Temperature","Temperature", Index=0)

AddTableRow
AddRow will add a row at the specified index to the table.

Return The Integer which corresponds to the index of the row which was newly
added to the table.

Type int

Required Arguments

Table The DataReference of the table to add this row of data.

Type DataReference

Optional Arguments

Data A List of Strings which specifies the data for this row. The String must be a valid Quantity string in
the form "value [units]".

Type List<Quantity>

Index The Integer index of the location for the newly added row. An index of 0 (zero) will add to the top
of the table. The default is to add the row to the end of the table.

Type int

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1074 of ANSYS, Inc. and its subsidiaries and affiliates.
Example
This example illustrates adding rows to a table.

# NameSpace is the Addin namespace in use (e.g. Study, EngData, etc.) which may have its specific CreateTa
# drParent is the DataReference of an object that has been previously created
table1 = NameSpace.CreateTable(Parent=drParent, Columns=[("Temperature","Temperature"),("Displacement","Len
table1.AddRow(Data=["100 [C]","1.0 [m]"])
table1.AddRow()
table1.AddRow(Data=["300 [C]",".06 [m]"])
table1.AddRow(Index=0, Data=["50 [C]",".001 [m]"])

Archive
Creates a project archive based on current project files and contents. The project must be saved before
an archive can be created.

Required Arguments

FilePath The full file path of the project archive to be created.

Type string

Optional Arguments

FailIfMissingFiles Set to true to force failure if there are any files to repair.

Type bool

Default Value False

IncludeExternalImportedFiles Whether to include files imported to the project from external locations.

Type bool

Default Value False

IncludeSkippedFiles Whether to include Results and Solution files in the archive.

Type bool

Default Value True

IncludeUserFiles Whether to include files in the project user_files directory.

Type bool

Default Value True

Example
This example creates a project archive from the currently loaded project. The full file path is specified and
the argument will include items from the user_files folder, include results/solution files, and exclude ex-
ternal files imported into the project.

Archive(FilePath=r"C:\Users\AnsUser\simpleStructural.zip",
IncludeUserFiles=True,
IncludeSkippedFiles=True,

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1075
Namespaced Commands

IncludeExternalImportedFiles=False,
FailIfFilesNeedRepair=False)

CleanSystem
Clears generated data on all components in the given system(s).

Required Arguments

Systems A list of systems to be cleaned.

Type List<DataReference>

ClearMessagesBySource
Clears all messages that have no Source from the message store.

Optional Arguments

Source The optional source of the message.

Type Object

SourceUsage The optional message storage arguments.

Type ClearMessagesOption

ClearMessages
Clears all messages from the message store.

ConvertRepositoryFileToLocalFile
Convert a repository file to local file

Required Arguments

File The reference to the file entity to be converted.

Type DataReference

CopyFile
Copies a file to a target directory. Either the SourceFile argument or the SourceFilePath argument must
be specified.

Return A reference to the created file is returned in this argument.

Type DataReference

Required Arguments

DestinationDirectoryPath The full path to the destination directory.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1076 of ANSYS, Inc. and its subsidiaries and affiliates.
Overwrite Specifies whether to overwrite an existing files of the same name. Note:
A registered file may not be overwritten.

Type bool

Optional Arguments

SourceFile A reference to the file to be copied. A file reference can be obtained from commands
and queries like RegisterFileCommand and GetRegisteredFileQuery.

Type DataReference

SourceFilePath A full path to the file to be copied.

Type string

Example
This example illustrates a path-based file copy procedure. The specified file will be copied to the specified
destination directory path. The destination file will not be registered and the return value will be null.

CopyFile(SourceFilePath=r"C:\Users\anyuser\myTextFile.txt",
DestinationDirectoryPath=r"C:\Users\anyuser\newfolder",
Overwrite=True)

This second example illustrates a reference-based file copy procedure. The specified file will be
copied to the specified destination directory path. The destination file will also be registered and
the new reference returned.

file1 = GetRegisteredFile(FilePath=r"C:\path_to_file\file.txt")
file2 = CopyFile(SourceFile=file1,
DestinationDirectoryPath=r"C:\Users\anyuser\newfolder",
Overwrite=True)

CreateCustomUnitSystem
Creates a custom unit system based on predefined unit system (e.g., MKS, US Customary) or other custom
unit sytem already defined.

Return A reference to the created UnitSystem data entity.

Type DataReference

Required Arguments

BaseUnitSystemName The internal name of the unit system that is the basis for the newly created
system.

Type string

UnitSystemDisplayName The displayed name of the new unit system.

Type string

UnitSystemName The internal name of the new unit system.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1077
Namespaced Commands

Type string

Example
This example illustrates the creation of a custom unit system.

myUnitSystem = CreateCustomUnitSystem(UnitSystemName="MyUnitSystem",
UnitSystemDisplayName="My Custom Unit System",
BaseUnitSystemName="SI")

CreateTemplateFromProject
Creates a Project Template from the current project and adds it to the list of Custom systems.

Return A reference to the created CustomProjectTemplate entity.

Type DataReference

Required Arguments

Name The name of the created template.

Type string

CreateUnitSystem
Creates the UnitSystem data entity for the named system.

Return A data reference to the created UnitSystem entity.

Type DataReference

Required Arguments

UnitSystemName The internal name of the unit system to be created.

Type string

DeleteFile
Deletes the specified file. Either the File argument or the FilePath argument must be specified.

Optional Arguments

BackUp Specifies whether to back up the file before deletion. This optional argument's default
value is true.

Type bool

Default Value True

DeleteIfShared Specifies whether a registered file should be deleted even if it is still in use. This optional
argument's default value is true. If this argument's value is false, an exception will be
thrown if a shared file is encountered. To avoid the exception, set ErrorIfShared to false.

Type bool

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1078 of ANSYS, Inc. and its subsidiaries and affiliates.
 Default Value False

ErrorIfShared Specifies whether to throw an exception when trying to delete a shared file if DeleteIf-
Shared is set to false.

Type bool

File A reference to the file to be deleted. A file reference can be obtained from commands
and queries like RegisterFileCommand and GetRegisteredFileQuery.

Type DataReference

Example
The following example illustrates a simple file deletion; file is not deleteed if it is registered.

DeleteFile(FilePath=r"C:\Users\anyuser\path-to-file.extension")

The next example illustrates forced file deletion.

DeleteFile(FilePath=r"C:\Users\anyuser\path-to-file.extension", DeleteIfShared=True)

The next example illustrates a deletion of a registered file via a file reference. The file will be deleted
if even if it is still in use. Note that the file will be backed up.

fileRef = GetRegisteredFile(FilePath=r"C:\Users\anyuser\path-to-file.extension")
DeleteFile(File=fileRef, DeleteIfShared=True,
BackUp=True)

The final example illustrates a deletion of a registered file via a file reference without a forced deletion.
If the file is shared, an error will not occur, and the file reference count will be decremented.

fileRef = GetRegisteredFile(FilePath=r"C:\Users\anyuser\path-to-file.extension")
DeleteFile(File=fileRef, ErrorIfShared=False)

DeleteTableColumn
DeleteColumn will delete a column at the specified index from the table.

Required Arguments

Index An Integer index or the String name of the column (case-sensitive) to remove from the table. The
first column has an index of 0 (zero).

Type Object

Table The DataReference of the table to delete the column from.

Type DataReference

Example
This example illustrates removing a column from a table.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1079
Namespaced Commands

# NameSpace is the Addin namespace in use (e.g. Study, EngData, etc.) which may have its specific CreateTa
# drParent is the DataReference of an object that has been previously created
table1 = NameSpace.CreateTable(Parent=drParent, Columns=[("Temperature","Temperature"),("Displacement","Len
table1.AddRow(Data=["100 [C]","1.0 [m]"])
table1.AddRow(Data=["200 [C]",".02 [m]"])
table1.AddRow(Data=["300 [C]",".06 [m]"])
table1.DeleteColumn(Index='Displacement')

DeleteTableRow
DeleteRow will delete a row at the specified index from the table.

Required Arguments

Index The Integer index of the row to remove from the table. The row indexes for the table begin at 0 (zero).

Type int

Table The DataReference of the table to delete the row from.

Type DataReference

Example
This example illustrates removing a row from a table.

# NameSpace is the Addin namespace in use (e.g. Study, EngData, etc.) which may have its specific CreateTa
# drParent is the DataReference of an object that has been previously created
table1 = NameSpace.CreateTable(Parent=drParent, Columns=[("Temperature","Temperature"),("Displacement","Len
table1.AddRow(Data=["100 [C]","1.0 [m]"])
table1.AddRow(Data=["200 [C]",".02 [m]"])
table1.AddRow(Data=["300 [C]",".06 [m]"])
table1.DeleteRow(Index=2)

DeleteTabularDataRow
Delete a row from a tabular data sheet.

Required Arguments

Index Index of the row to delete.

Type int

TabularData Data Entity that can be bound to ITabularDataWrite

Type DataReference

Optional Arguments

SheetName Name of the sheet to access.

Type string

SheetQualifiers SheetQualifiers is used to pass in the qualifiers to select between multiple sheets witht
the same name. This is a dictionary of the Qualifier and its Value.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1080 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type Dictionary<string, string>

Example
The following example illustrates the deletion of a row from a tabular data sheet.

#
# Create a new Engineering Data System and access Structural Steel
#
template1 = GetTemplate(TemplateName="EngData")
system1 = template1.CreateSystem()
engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
#
# Delete the first row in the Density property
#
matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.DeleteTabularDataRow(Index = 0)
#
# Delete the first row in the Coefficient of Thermal Expansion property with optional SheeetNamea nd SheetQ
#
matlProp2 = matl1.GetProperty(Name="Coefficient of Thermal Expansion")
matlProp2.DeleteTabularDataRow(
SheetName="Coefficient of Thermal Expansion",
SheetQualifiers={"Definition Method": "Secant", "Behavior": "Isotropic"},
Index = 0)

DeleteUnitSystem
Deletes the named unit system.

Required Arguments

UnitSystemName The name of the unit system to delete.

Type string

DownloadRepositoryFile
Download the specified file from repository

Return Holds the reference to the Repository file as the output value.

Type DataReference

Required Arguments

RepositoryFile The repository file info to be downloaded

Type RepositoryFileInfo

ExportReport
Writes out project report containing both framework- and addin-supplied content. The report output
is XML in accordance to EKM schema. If the file path extension is html, the XML will be converted to
an html output file.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1081
Namespaced Commands

Required Arguments

FilePath The full destination file path for the reporting. If the extension is .xml, the report will be produced
in XML format per EKM schema. If the extension is .html, the report will be poduced using the
EKM schema-certified XML and then translated in html.

Type string

GetAbsoluteUserPathName
Gets the absolute user path name for the given relative path name, based on the current setting of the
user path root. See also GetUserPathRoot and SetUserPathRoot.

Return The returned absolute user path name.

Type string

Required Arguments

RelativePathName The relative path name.

Type string

Example
This example uses the SetUserPathRoot and GetAbsoluteUserPathName to read a project from two different
user directories.

SetUserPathRoot(DirectoryPath = "C:/Users/myUser1/Projects")
Open(FilePath=GetAbsoluteUserPathName("proj1.wbpj")) # Read project from first location
SetUserPathRoot(UserPathRoot = "C:/Users/myUser2/Projects")
Open(FilePath=GetAbsoluteUserPathName("proj1.wbpj")) # Read project from second location

GetAllFiles
Gets the list of all files that have been registered with the project (even if external to the project directory)
or exist within the project files directory.

Return List of paths to all known project files.

Type List<string>

GetAllSystems
Query to return the set of Data References to all System entities in the project.

Return Data Reference set of Systems

Type DataReferenceSet

GetComponentTemplate
Query to return the Data Reference to the Component Template of the given name.

Return Component Template Data Reference.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1082 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataReference

Required Arguments

Name Full name of the Component Template.

Type string

GetCurrentRegisteredFiles
Gets the files registered with the project.

Return The set of data references to registered files.

Type DataReferenceSet

GetDesignPointUpdateSettings
Query to return the singleton DesignPointUpdateSettings.

Return DesignPointUpdateSettings Data Reference.

Type DataReference

GetFileReference
Gets the File Reference to a registered file based upon the file reference's name. Throws an Invalid
Operation Exception if a matching File Reference is not found.

Return The data reference of the file whose name matches the supplied paramet-
er.

Type DataReference

Required Arguments

Name The file reference name.

Type string

GetFilesForDirectory
Gets the set of data references to registered files within a directory.

Return The set of data references to files in the directory.

Type DataReferenceSet

Required Arguments

DirectoryPath The full path to the directory.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1083
Namespaced Commands

GetFileType
Returns a reference to a FileType data entity, given the data entity name of the FileType object.

Return The data reference to the FileType data entitity.

Type DataReference

Required Arguments

Name The data entity name of the FileType object.

Type string

GetFrameworkBuildVersion
Get the current framework build version.

Return Return the framework build version.

Type string

GetLicenseNames
Query to return license features ID and names.

Return Returns license feature IDs along with readible names.

Type Dictionary<string, string>

GetMaxProjectPathLength
Gets the max project path length created in WorkBench based on the project directory and project
name.

Return The max project path length

Type int

Required Arguments

ProjectDirectory The full path to the project directory.

Type string

ProjectName The project name

Type string

GetMessages
Returns DataReferences for all stored messages, ordered by message publication date/time with most
recent messages first.

Return The list of StoredMessage data entities for current messages.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1084 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type DataReferenceSet

GetNeededLicenses
Query to return the needed licenses to update project.

Return Needed licenses based on previous updates, with license feature ID as

key, along with needed count.

Type Dictionary<string, int>

GetPersistedProjectVersion
Given the path to a WB project, return the last-saved-in version. Note: The command will return '00' if
a project is not supplied and the current session project has not been saved.

Return The Project's persisted version (e.g, 120, 121, 130, 140, 145, ...).

Type string

Optional Arguments

FilePath The Project File Path (wbpj).

Type string

GetProjectDirectory
Gets the full path to the current project directory.

Return The project directory full path.

Type string

GetProjectFile
Gets the full path of the current project file (*.wbpj).

Return The full path of the current project file.

Type string

GetProjectTemplate
Query to return the Project Template of the given name.

Return Project Template Data Reference.

Type DataReference

Required Arguments

Name Full name of the Project Template.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1085
Namespaced Commands

GetProjectUnitSystem
Gets the current unit system for the project.

Return A reference to the UnitSystem data entity.

Type DataReference

GetPropertyExpression
Gets the expression defining a data entity property's value.

Return Returns the expression that currently defines the property's value.

Type string

Required Arguments

Entity The entity to query.

Type DataReference

Name The property name or member path.

Type string

GetQuantityUnitForUnitSystem
Gets the unit for a quantity in the specified unit system.

Return The current Unit for the quantity.

Type string

Required Arguments

QuantityName The name of the Quantity of interest.

Type string

UnitSystemName The internal name of the unit system.

Type string

GetRegisteredFile
Gets the File Reference to a registered file based upon the file's path.

Return The data reference of the file whose location points to the specified path.
Null if no data reference is found.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1086 of ANSYS, Inc. and its subsidiaries and affiliates.
Required Arguments

FilePath The full path of the file.

Type string

GetRegisteredFilesForDirectory
Gets list of File References for a directory path.

Return The list of data reference of files whose location root is DirectoryPath.
Empty list if no data reference is found.

Type DataReferenceSet

Required Arguments

DirectoryPath The full path to the directory.

Type string

GetSchematicSettings
Query to return the singleton SchematicSettings.

Return SchematicSettings Data Reference.

Type DataReference

GetScriptVersion
returns the software version that the current script that is being executed is compliant with

Return the software version that the current script that is being executed is
compliant with

Type string

GetSolveManagerQueues
Query to return queues available from a solver manager host.

Return List of queues, or null if the SolverManagerHost is not ready or invalid

host.

Type List<string>

Required Arguments

SolverManagerHost Name of the solve manager

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1087
Namespaced Commands

GetSystem
Query to return the Data Reference to the system of the given name.

Return System Data Reference

Type DataReference

Required Arguments

Name Full name of the System

Type string

GetTableData
GetData will return the data in a table.

Return A List of Strings or a List of List of Strings for the requested range.

Type List<Object>

Required Arguments

Table The DataReference of the table to get data from.

Type DataReference

Optional Arguments

ColumnRange A Tuple of the column starting index and ending index to access the data. The default is (0,
maximumColumns - 1). A single index may be used also to return a single column. The first
column has an index of 0 (zero).

Type Object

RowRange A Tuple of the row starting index and ending index to access the data. The default is (0,
maximumRows - 1). A single index may be used also to return a single row. The first row has
an index of 0 (zero).

Type Object

Example
This example illustrates data retrieval from a table.

# drParent is the DataReference of an object that has been previously created

table1 = drParent.CreateTable(Columns=[("Temperature","Temperature"),("Displacement","Length")])
table1.AddRow(Data=["100 [C]","1.0 [m]"])
table1.AddRow(Data=["200 [C]",".02 [m]"])
table1.AddRow(Data=["300 [C]",".06 [m]"])
table1.GetData(RowRange=1) # get the second row of the table
table1.GetData(RowRange=(1,2)) # get the second and third row of the table
table1.GetData() # complete table in row-major
# Get table as column major
numCol = len(table1.GetData(RowRange=0))
colMajorArr = [0 for i in range(numCol)]
for colIdx in range(numCol):
colMajorArr[colIdx] = [row[colIdx] for row in table1.GetData()]

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1088 of ANSYS, Inc. and its subsidiaries and affiliates.
 colMajorArr

GetTabularData
Returns the tabular data associated with the data entity.

Return The returned data in scalar, list, or dictionary format.

Type Object

Required Arguments

TabularData Data entity that has associated tabular data.

Type DataReference

Optional Arguments

AsDictionary If set to true, the data will be returned as a dictionary where the keys are variable names
and the values are the data for each variable. If set to false, the data will be returned
in scalar or list format without the variable names.

Type bool

Default Value False

ColumnMajor If set to true, the data will be returned in column-major order. If set to false, the data
will be returned in row-major order.

Type bool

Default Value True

EndIndex The end index for requesting a subset of the data (zero-based).

Type int

Default Value -2147483647

SheetName Specifies the sheet name when the data contains multiple sheets.

Type string

SheetQualifiers Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.

Type Dictionary<string, string>

StartIndex The start index for requesting a subset of the data (zero-based).

Type int

Default Value 0

Variables Names of the variables for which data is requested (string or list of strings).

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1089
Namespaced Commands

Type Object

Example
In this example, all data is requested for the given tabular data entity.

tabData1.GetData()

In this example, all data is requested in row-major order.

tabData1.GetData(ColumnMajor=False)

In this example, all data is requested in dictionary format.

tabData1.GetData(AsDictionary=True)

In this example, data for variables Density and Temperature is requested in dictionary format.

tabData1.GetData(Variables=["Density", "Temperature"], AsDictionary=True)

GetAllTeamcenterConnections
A query to return all Teamcenter geometry connections.

Return A list of Teamcenter source strings.

Type List<string>

GetTemplate
Query to return a System Template reference, based on the template name and additional solver spe-
cification.

Return Template Data Reference.

Type DataReference

Required Arguments

TemplateName Generic name of the Template, without any solver-specific designation.

Type string

Optional Arguments

Solver The name of the solver to qualify the specific template.

Type string

GetUnitsDisplaySettings
Gets the value of units display settings ("DisplayValuesAsDefined" or "DisplayValuesInProjectUnits").

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1090 of ANSYS, Inc. and its subsidiaries and affiliates.
Return The current value of the Units display setting.

Type string

GetUnitSystem
Gets a reference to the UnitSystem entity of the given internal name.

Return A reference to the UnitSystem data entity.

Type DataReference

Required Arguments

UnitSystemName The internal name of the unit system.

Type string

GetUnitSystemsNames
Gets the internal names of all currently defined unit systems (Predefined and Custom Unit Systems).

Return A list of the internal names of currently defined unit systems.

Type List<string>

GetUserFilesDirectory
Gets the current user_files directory.

Return The full path to the user_files directory.

Type string

GetUserPathRoot
Gets the current user path root.

Return The user path root.

Type string

ImportFile
Imports a file into the project. The result of the import varies, dependent upon the file type's defined
import behavior. Usually a corresponding system is created in the project view. Sometimes, the file is
simply added to the files view. To be imported, a file's type must be registered and the ImportFileCom-
mandName property must be non-null. Use FileTypeRepository.RegisterFileTypeTemplate or FileTypeTem-
plateRecord.ImportFileCommandName to specify the command to be invoked when importing a file
of a given type.

Required Arguments

FilePath The full path to the file to import.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1091
Namespaced Commands

Type string

Optional Arguments

FileType The reference to the type of the file to import. If not specified, the type will be inferred from the
file's extension.

Type DataReference

ImportJournalVariables
Imports any variables defined in the currently-recorded journal file into the scripting environment so
they can be accessed in the command window.

ImportUnitSystem
Imports a unit system from a Units .xml file.

Return A reference to the created UnitSystem data entity.

Type DataReference

Required Arguments

FilePath The full path to the file to be imported.

Type string

Optional Arguments

UnitSystemName The internal name of the unit system to be created.

Type string

IsProjectUpToDate
A query to determine if all systems and their components in the project are up to date.

Return The return is True if the project is up to date.

Type bool

MergeRsmProject
Merging multiple project tasks solved from RSM design point updates into the current project. This
command should *NOT* be used to merge any un-related projects. Solved projects may be either inter-
mediate or final results.

Required Arguments

MergingProjects The dictionary contains full file path of base project of the RSM project as key, and a
dictionary of the full file path to the updated RSM project and its design points to be
merged into the current project as value. The file paths can be either standard wbpz
file or partial wppz file or wbpj file. If the project is a standard wbpz or partial wppz

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1092 of ANSYS, Inc. and its subsidiaries and affiliates.
 archive, it will be unpacked to a sub-directory (whose name is the same as archive file
name) under the same directory as the wbpz directory first before merging.

Type Dictionary<string, Dictionary<string, List<DataReference>>>

Optional Arguments

DoRevertibleSave Whether do revertible save or not

Type bool

Default Value True

KeepFilesInRsmProject Determines whether we should keep the project files from the (unarchived)
RSM project after it is merged into the current project. Note that keeping the
RSM project will significant slow down the project file merging performance
and will require more disk space. If this option is false, it is up to the caller to
backup the original project first. Also note that if the ProjectFilePath is a *.wbpz
file, it will not be affected.

Type bool

Default Value True

Overwrite If the ProjectFilePath is an archive file (*.wbpz), and if the same unpacked
project already exists on the same directory, this flag determines whether we
should overwrite it.

Type bool

SaveFirst Whether to save the project before merging.

Type bool

Example
The following example illustrates how this command may be used to merge all Design Points from RSM-
solved projects into the current project. Existing Rsm Project files are retained. Any existing archive with
the same name in the destination project will be overwritted. The project will be first saved using a revertible
save.

MergeRsmProject(MergingProjects={(r"Path_to_RSM_Project", {(r"Path_to_current_project", {Updated DesignPoin

KeepFilesInRsmProject=True,
Overwrite=True,
SaveFirst=True,
DoRevertibleSave=True)

MoveFile
Moves a file to a new directory. Either the File argument or the FilePath argument must be specified.

Required Arguments

NewDirectoryPath The full path to the destination directory.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1093
Namespaced Commands

Optional Arguments

BackUp Specifies whether to back up the file before the move. This optional argument's default value is
true.

Type bool

Default Value True

File A reference to the file to be moved. A file reference can be obtained from commands and queries
like RegisterFileCommand and GetRegisteredFileQuery.

Type DataReference

FilePath A full path to the file to be moved.

Type string

Example
This example illustrates a path-based file move procedure. The specified file will be moved to the specified
destination directory path.

MoveFile(FilePath=r"C:\Users\anyuser\myTextFile.txt",
NewDirectoryPath=r"C:\Users\anyuser\newfolder")

This second example illustrates a reference-based file move procedure. The specified file will be
moved to the specified destination directory path.

file1 = GetRegisteredFile(FilePath=r"C:\path_to_file\file.txt")
MoveFile(SourceFile=file1,
NewDirectoryPath=r"C:\Users\anyuser\newfolder")

This final example also illustrates a reference-based file move procedure. The specified file will be
moved to the specified destination directory path. The file will not be backed up prior to the move.

file1 = GetRegisteredFile(FilePath=r"C:\path_to_file\file.txt")
MoveFile(SourceFile=file1,
NewDirectoryPath=r"C:\Users\anyuser\newfolder",
Backup=False)

Open
Opens a Workbench project from the specified .wbpj file.

Required Arguments

FilePath The full path to the project file to open.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1094 of ANSYS, Inc. and its subsidiaries and affiliates.
Refresh
Refreshes the input data for the entire project by reading changed data from upstream sources. Does
not perform any calculations or updates based on the new data.

RegisterFile
Registers the specified file with the project. Either the FilePath argument or the RepositoryFile argument
must be specified.

Return Holds the reference to the registered file as the output value.

Type DataReference

Optional Arguments

FilePath A full path to the file to be registered.

Type string

FileType The reference to the type of the file to register. If not specified, the type will be inferred from
the file's extension.

Type DataReference

Example
This example illustrates a path-based file registration procedure. The specified file will be registered and
the resulting file reference will be returned.

file1 = RegisterFile(FilePath=r"C:\Users\anyuser\myTextFile.txt")

This second example illustrates a file type based file registration procedure. The specified file will
be registered with the corresponding (supplied) file type and the resulting file reference will be re-
turned.

fileType1 = GetFileType(Name="MyFileType")
file1 = RegisterFile(FilePath=r"C:\Users\anyuser\myFile.abc",
FileType=fileType1)

RemovePropertyTable
Remove a table reference from a property to prevent its use in an expression. If the property does not
support an expression an error will occur.

Required Arguments

Index The integer which uniquely identifies the Table for use in the expression of the Property.

Type uint

Parent The DataReference of the object which has the Property that the Table should be removed from.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1095
Namespaced Commands

Property The String which provides the path of the property on the Parent.

Type string

Example

tbl1 = pressure1.CreateTable(Columns=[[“X”, “Length”], [“Y”, “Length”], [“Pressure”, “Pressure”]])

bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Independents=[“X”, “Y”], Dependents=[“Pressure”])
# In the table function the x and y refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(x, y)”)
bc1.RemovePropertyTable(Property=“Magnitude”, Index=1);

RenameFile
Renames a file. Either the File argument or the FilePath argument must be specified.

Required Arguments

New- The new file name, excluding the directory path. To change the directory, see MoveFileCommand.
Name
Type string

Optional Arguments

BackUp Specifies whether to back up the file before renaming it. This optional argument's default value
is true.

Type bool

Default Value True

File A reference to the file to be renamed. A file reference can be obtained from commands and
queries like RegisterFileCommand and GetRegisteredFileQuery.

Type DataReference

FilePath A full path to the file to be renamed.

Type string

Example
This example illustrates a path-based file rename procedure. The specified file will be renamed with the
specified new name.

RenameFile(FilePath=r"C:\Users\anyuser\myTextFile.txt",
NewName="myTextFileRENAMED.txt")

This second example illustrates a reference-based file rename procedure. The specified file reference
will be renamed with the specified new name.

file1 = GetRegisteredFile(FilePath=r"C:\path_to_file\file.txt")
RenameFile(File=file1,
NewName="fileRENAMED.txt")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1096 of ANSYS, Inc. and its subsidiaries and affiliates.
 This final example also illustrates a reference-based file rename procedure. The specified file will be
renamed with the specified new name. The file will not be backed up prior to the move.

file1 = GetRegisteredFile(FilePath=r"C:\path_to_file\file.txt")
RenameFile(File=file1,
NewName="fileRENAMED.txt",
Backup=False)

RenameUnitSystem
Renames a unit system.

Required Arguments

UnitSystemName The name of the unit system to be changed.

Type string

UnitSystemNewName The new name of the unit system.

Type string

Reset
Resets Workbench to an empty project. Any unsaved changes in the current project are lost.

Resolve
A command used to resolve the data object to make it consistent with the rest of the data model

Required Arguments

Entity The entity to resolve.

Type DataReference

ResumeBackgroundDesignPointUpdate
Resume given design point update session previously submitted for remote execution.

Return Optional output which will be set immediately to the input session. It is
provided for the convenience of the invoking code so that the same type
of output can be returned from this vs. UADP command.

Type DataReference

Optional Arguments

Session If not specified, top level background UADP sessions will be resumed.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1097
Namespaced Commands

ResumeDesignPointUpdates
Resume design point updates suspended waiting for subtasks executed in background; or resume sus-
pended parametric updates.

RunScript
Executes a Workbench script file from the specified location.

Required Arguments

FilePath Full path to the script file to execute.

Type string

Save
Saves the current project to disk.

Optional Arguments

FilePath The full path of the project file to be saved.

Type string

Overwrite Whether to overwrite the project save location if it exists.

Type bool

SaveProjectArchiveToTeamcenter
Saves a project archive to Teamcenter. The project archive must be created before calling this function.

Required Arguments

ArchiveFileName Archive file name

Type string

TeamcenterUserName Teamcenter User Name

Type string

TeamcenterUserPassword Teamcenter User Password

Type string

Optional Arguments

DatasetDescription Item description

Type string

DatasetName Dataset name. ArchiveFileName will be considered as the Dataset name, if

(ItemName and ItemRevision) or Dataset name is not specified

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1098 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

DeleteArchiveOnExit Deletes the archive file name on exiting the process

Type bool

Default Value False

ItemName Teamcenter Item name

Type string

ItemRevision Teamcenter Item Revision

Type string

ItemRevisionUID Teamcenter Item Revision UID

Type string

ItemSequence Item sequence number

Type string

ItemUID Teamcenter Item UID

Type string

SSLCACertificateFile Teamcenter SSL CA Certificate File for HTTPS connections

Type string

TeamcenterDiscriminator Teamcenter Discriminator

Type string

Default Value ANSYSWBPlugInTC

TeamcenterGroup Teamcenter Group

Type string

TeamcenterLocale Teamcenter Locale. eg. en_US

Type string

TeamcenterRole Teamcenter Role

Type string

WaitForExitMillisecond Wait till teamcenter checkin is finished

Type int

Default Value 30000

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1099
Namespaced Commands

Example
Saves a project archive to Teamcenter

SaveProjectArchiveToTeamcenter(ArchiveFileName=r"C:\Users\AnsUser\simpleStructural.wbpz",
TeamcenterUserName="infodba",
TeamcenterUserPassword="infodba",
ItemName="ANS0048",
ItemRevision="001",
Decription="Workbench2 Project Archive")

SetDesignPointUpdateOption
Set the design point updates run mode.

Required Arguments

UpdateOption Update option to be set.

Type JobRunMode

SetProjectUnitSystem
Sets the unit system for the current project.

Return A reference to the UnitSystem entity that is now the project unit system.

Type DataReference

Required Arguments

UnitSystemName The internal name of the unit system to be used in the project.

Type string

SetQuantityUnitForUnitSystem
Sets the unit for a Quantity in the specified unit system. Changing Base or Common units will change
derived units if appropriate. Note: Quantity unit for a predefined unit system cannot be changed. Note:
Only consistent units (SI or US Customary) are allowed.

Return A dictionary of the Quantity names and new units for all resulting quantity
changes. This will be more than just the target quantity if a base unit is
changed.

Type Dictionary<string, string>

Required Arguments

QuantityName The name of the Quantity to be changed.

Type string

Unit The new Unit for the quantity.

Type string

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1100 of ANSYS, Inc. and its subsidiaries and affiliates.
UnitSystemName The internal name of the unit system to be changed.

Type string

Example
The following example illustrates the setting of a quantity unit in a given unit system.

changedUnits = SetQuantityUnitForUnitSystem(UnitSystemName="myUnitSystem",
QuantityName="Temperature",
Unit="C")

SetScriptVersion
Sets the command API version used when executing a script.

Required Arguments

Version The command API version required to run the script. This string can either a 2 or 3 part version
string.

Type string

SetTableData
SetData will overwrite the data in a table beginning at the specified location.

Required Arguments

Column An Integer index or the String name of the column (case-sensitive) to begin setting data. The first
column has an index of 0 (zero).

Type Object

Data A String or List of Strings which specifies the data to set at the given row and column of the table.
The String must be a valid Quantity string in the form "value [units]". If a List is used see the DataOrder
argument for behavior.

Type List<Quantity>

Row The Integer index of the row of the table to begin setting data. The first row has an index of 0 (zero).

Type int

Table The DataReference of the table which will have data changed.

Type DataReference

Optional Arguments

DataOrder An enum of Row or Column which indicates if the Data is entered in a row-major or column-
major order. The default is Row.

When the DataOrder is Row the data is set beginning at the specified position and con-
tinues in the row. If the operation for the List of data would exceed the number of
columns an error will occur.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1101
Namespaced Commands

When the DataOrder is Column the data is set beginning at the specified position and
continues in the column. If the operation for the List of data would exceed the number
of rows an error will occur.

Type DataOrder

Default Value Row

Example
This example illustrates setting data in a table.

# NameSpace is the Addin namespace in use (e.g. Study, EngData, etc.) which may have its specific CreateTa
# drParent is the DataReference of an object that has been previously created
table1 = NameSpace.CreateTable(Parent=drParent, Columns=[("Temperature","Temperature"),("Displacement","Len
table1.AddRow(Data=["100 [C]","1.0 [m]"])
table1.AddRow(Data=["200 [C]",".02 [m]"])
table1.AddRow(Data=["300 [C]",".06 [m]"])
tableData = ["100 [C]","0.0 [m]"]
table1.SetData(Row=0, Column=0, Data=tableData)

SetTabularData
Set tabular data associated with the data entity.

Required Arguments

TabularData Data entity that has associated tabular data.

Type DataReference

Optional Arguments

Data Sets the data using a dictionary form. The keys are the variable names and the values
are the data. The use of this argument is mutually exclusive with "Values" and "Vari-
ables".

Type Dictionary<string, List<Object>>

Index Specifies the starting location used to set the data (zero-based). A value of -1 indicates
that the data should be appended to the existing data.

Type int

Default Value 0

SheetName Specifies the sheet name when the data contains multiple sheets.

Type string

SheetQualifiers Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.

Type Dictionary<string, string>

Values List of data values set in conjunction with the "Variables" parameter. This parameter
and the "Data" parameter are mutually exclusive.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1102 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type List<List<Object>>

Variables Names of the variables for which data is being set. This parameter and and the "Data"
parameter are mutually exclusive.

Type List<string>

Example

#
# Create a new Engineering Data System and access Structural Steel
#
template1 = GetTemplate(TemplateName="EngData")
system1 = template1.CreateSystem()
engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
#
# Change the value of a simple single-valued property
#
matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.SetData(
Variables="Density",
Values="8500 [kg m^-3]")
#
# Set Temperature-dependent data for Elasticity based
# on lists of variables and values.
matlProp2 = matl1.GetProperty(Name="Elasticity")
temperature = ["400 [K]", "600 [K]", "800 [K]"]
E = ["2e5 [MPa]", "1.9e5 [MPa]", "1.6e5 [MPa]"]
matlProp2.SetData(
Variables = ["Temperature","Young's Modulus"],
Values = [temperature, E])
#
# Change the Temperature for the second table entry.
#
matlProp2.SetData(
Index = 1,
Variables = "Temperature",
Values = "625 [K]")
#
# Set a list for Poisson's Ratio starting at the second table entry.
#
matlProp2.SetData(
Index = 1,
Variables = "Poisson's Ratio",
Values = [0.3, 0.3])
#
# Set Temperature-dependent property data for the Coefficient of Thermal Expansion
# using a dictionary. The dictionary key is the Variable name,
# followed by the list of values for the variable.
#
matlProp3 = matl1.GetProperty(Name="Coefficient of Thermal Expansion")
newData = {"Temperature": ["200 [F]","400 [F]","600 [F]","800 [F]","1000 [F]"],
"Coefficient of Thermal Expansion" : ["6.3e-6 [F^-1]", "7.0e-6 [F^-1]",
"7.46e-6 [F^-1]", "7.8e-6 [F^-1]",
"8.04e-6 [F^-1]"]}
matlProp3.SetData(
SheetName="Coefficient of Thermal Expansion",
SheetQualifiers={"Definition Method": "Secant", "Behavior": "Isotropic"},
Data = newData)

SetTabularDataQualifier
Changes the values of a specifiec qualifier in a data table.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1103
Namespaced Commands

Required Arguments

Qualifier The Qualifier to Set.

Type string

TabularData Data Entity that can be bound to ITabularDataWrite

Type DataReference

Value The new value.

Type string

Optional Arguments

SheetName The name of the tabular data sheet that contains the qualifier.

Type string

SheetQualifiers SheetQualifiers can be used to pass in the qualifiers to select between multiple
sheets witht the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

VariableName The name of the Variable that contains the qualifier to be changed.

Type string

VariableQualifiers VariableQualifiers can used to pass in the qualifiers to select between multiple
variables witht the same name. This is a dictionary of the Qualifier and its Value.

Type Dictionary<string, string>

Example
The following example changes the 'Derive From' setting within an Isotropic Elasticity material property
to be "Bulk Modulus and Poisson's Ratio".

matl1 = engineeringData1.GetMaterial(Name="Structural Steel")

matlProp1 = matl1.GetProperty(Name="Elasticity")
matlProp1.SetQualifier(
SheetName="Elasticity",
Qualifier="Derive from",
Value="Bulk Modulus and Poisson's Ratio")

SetUnitsDisplaySettings
Sets units display settings.

Required Arguments

DisplaySettings The new value to be used for Unit display settings. Allowed values are:

DisplayValuesAsDefined
DisplayValuesInProjectUnits

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1104 of ANSYS, Inc. and its subsidiaries and affiliates.
 Type string

SetUserPathRoot
Sets the current user path root. The root path facilitates portability of session journals by allowing rel-
ative rather than absolute paths to be recorded. During command journal replay, paths are reconstructed
using the active user path root setting.

Required Arguments

DirectoryPath The new root directory path.

Type string

Unarchive
Restores a project from an archive to the specified location.

Required Arguments

ArchivePath The project archive file path to open.

Type string

Overwrite Whether the project should be overwritten if it already exsits.

Type bool

Optional Arguments

ProjectPath The path to which the archived project will be uncompressed. If not specified, it will be ex-
tracted to a directory under "ProjectTemporaryFilesFolder" set by user preference. If the
"ProjectTemporaryFilesFolder" is not set, it will be extracted to a directory under system
temp directory.

Type string

Example
This example illustrates an unarchive procedure. The specified archive will be un-archived to the specified
project file path. If the project file path already exists, it will be overwritten since Overwrite=True.

Unarchive(ArchivePath=r"C:\Users\anyuser\myProjectArchive.wbpz",
ProjectFilePath=r"C:\Users\anyuser\myProject.wbpj",
Overwrite=True)

UpdateAllDesignPoints
Updates all design points or a subset of them if specified.

Return The reference to the DesignPointUpdateBackgroundSession object, if the

command is executed via RSM.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1105
Namespaced Commands

Optional Arguments

CannotCompleteBehavior Determines the action to take when a component cannot be updated but
does not have an error, for example if it needs user intervention.

Type UpdateErrorBehavior

Default Value Continue

DesignPoints The set of design points to update. If this parameter is not given, all out of
date design points are updated.

Type List<DataReference>

ErrorBehavior Determines the action to take when an error is encountered.

Type UpdateErrorBehavior

Default Value Continue

Parameters The set of parameters to update. If this parameter is not given, all parameters
are updated.

Type List<DataReference>

Example
The following example illustrates a more verbose usage of UpdateAllDesignPoints, as general users will
typically call just UpdateAllDesignPoints(). The following call processes two design points for all parameters
(all when None is specified), skips the executing design point when observing an error, and stops if a design
point update cannot be completed.

dps = []
dp = Parameters.GetDesignPoint("1")
dps.append(dp)
dp = Parameters.GetDesignPoint("2")
dps.append(dp)
UpdateAllDesignPoints(DesignPoints=dps,
Parameters=None,
ErrorBehavior="SkipDesignPoint",
CannotCompleteBehavior="Stop")

Update
Updates all components in the project by refreshing all input data and performing local calcuations to
produce new output if the component is out of date.

ValidateDesignPointUpdateSettings
Validate DesignPointUpdateSettingsEntity initialization.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1106 of ANSYS, Inc. and its subsidiaries and affiliates.
Study
This namespace holds top-level commands and queries related to Study

CreateTask
Create a task, given the name for the task type.

Return The component created for the task.

Type DataReference

Required Arguments

System The system where the task component should be created.

Type DataReference

Type The task type to create.

Type string

Optional Arguments

Input Optional, the task component which should be an upstream source for the created component.

Type DataReference

Output Optional, the task component which should be downstream of the created component.

Type DataReference

Example
Required example does not exist.

CreateGroup
Create a new task group based on the given task group name.+

Return The newly created group

Type DataReference

Required Arguments

Name The name of the new group

Type string

GetAllEngineeringDataInProject
Find all engineering data objects in the project.

Return All engineering data objects in the project

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1107
Namespaced Commands

Type DataReferenceSet

GetAllLeafTasksInProject
Returns all leaf tasks in the project.

Return All leaf tasks in the project.

Type DataReferenceSet

GetAllRootTasksInProject
Returns all root tasks in the project.

Return All root tasks in the project.

Type DataReferenceSet

GetAllTasksInProject
Returns all tasks in the project.

Return All tasks in the project.

Type DataReferenceSet

GetInputMesh
If available for a task, return the input mesh; otherwise null.

Return The input mesh.

Type DataReference

Required Arguments

Task The task to query.

Type DataReference

GetInputModel
If available for a task, return the input model; otherwise null.

Return The input model.

Type DataReference

Required Arguments

Task The task to query.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1108 of ANSYS, Inc. and its subsidiaries and affiliates.
GetOutputMesh
If available for a task, return the output mesh; otherwise null.

Return The output mesh.

Type DataReference

Required Arguments

Task The task to query.

Type DataReference

GetOutputModel
If available for a task, return the output model; otherwise null.

Return The output model.

Type DataReference

Required Arguments

Task The task to query.

Type DataReference

GetReferences
Returns a list of reference strings of the specified model components.

Return A List of the reference strings of the specified model components.

Type List<string>

Required Arguments

ModelComponents The DataReferenceSet of the model components of interest.

Type DataReferenceSet

GetReferenceString
Returns a reference string for a user object. This is a special case query, for those objects that contain
references, not stored in LocationSets. For now, works on Locator objects only, and is to be used to
retrieve the surface area of bounded surfaces: Sphere, Torus, and CappingSurface only.

Return Reference string for the specified object.

Type string

Required Arguments

ObjectReference The DataReference for the specified object that is assumed to be Analytic.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1109
Namespaced Commands

Type DataReference

GetTaskUserObjectBelongsTo
Returns a data reference to a Task that the provided UserObject maps to. May return null.

Return The input tasks for the given task.

Type DataReference

Required Arguments

UserObjectReference The user object to map to a task.

Type DataReference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1110 of ANSYS, Inc. and its subsidiaries and affiliates.
Data Types

Data Types
A breakdown of the types represented in this document

AdaptKrigOutType
Enumeration for the Output Variable Combinations type when refining for the Kriging algorithm.

Possible Values
AK_MAXOUT Maximum Output
AK_ALLOUT All Outputs
AK_SUMOUT Sum of Outputs

Aggressive
Used to specify whether mesh may deviate from geometry as a result of wrapper surface improvement.
The default value is MeetTarget.

Possible Values
MeetTarget Modify the geometry as needed to meet
quality target.
MaintainGeometry Compromise targets to maintain geometry.

AnalysisType
3D/2D import option

Possible Values
AnalysisType_3D Import all 3D objects
AnalysisType_2D Import only 2D objects (The model must be
in the x-y plane.)

AutoAsymmetryBehavior
A flag to notify the program if auto-asymmetry should be used in the physics solution. This option is
available if the Symmetry Behavior is set to Yes.

Possible Values
Yes
No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1111
Data Types

AxesRangeModes
Enumeration of the Automatic Range modes for output parameters.

Possible Values
OutputParameterMinMax The range of the output parameter axis is de-
termined from the minimum and maximum
of the parameter (min-max search of DPs min-
max)
ChartData The range of the output parameter axis is de-
termined by the min and max of the chart's
data.

Axis
The specification of allowed chart axes.

Possible Values
None
X_Axis
Y_Axis
Z_Axis

AxisDefineBy
Options for defining an axis

Possible Values
Direction
Point

AxisType
Options specifying which axis to define

Possible Values
XAxis
YAxis
ZAxis

BiasMethod
Used to specify the bias option. Currently, this is always SmoothTransition.

Possible Values
SmoothTransition

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1112 of ANSYS, Inc. and its subsidiaries and affiliates.
BiasType
Used to specify the option for bias type. The default value is Constant.

Possible Values
Right
Left
CenterIn
CenterOut
Constant

BladeLoftType
Enumeration of the possible blade lofting directions.

Possible Values
Streamwise
Spanwise

BladeType
Blade type for export to BladeGen

Possible Values
IGV IGV
Rotor Rotor
OGV OGV

BladeType
Blade type for export to BladeGen

Possible Values
IGV IGV
Rotor Rotor
OGV OGV

BMunitsType
BladeGen/BladeEditor units type

Possible Values
m Create blade model in metres
cm Create blade model in cm
mm Create blade model in mm
inches Create blade model in inches
ft Create blade model in feet

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1113
Data Types

BMunitsType
BladeGen/BladeEditor units type

Possible Values
mm Create blade model in mm
inches Create blade model in inches

BodyGrouping
The body grouping property used when importing the model.

Possible Values
None No body grouping action should be per-
formed.
Material The model should be grouped by material IDs.
ElementType The model should be grouped by element
type IDs.
Thickness The model should be grouped by thickness
IDs.
Components The model should be grouped by component
IDs.
Unknown The body grouping property is not set.

BodyGroupingType
Type of geometry that is being attached.

Possible Values
MaterialNumber
MaterialNumberAndThickness

BoltDefineBy
No details are provided for this entry.

Possible Values
ProgramControlled
UserDefined

bool
This type represents a Boolean value. Valid values are 'True' or 'False'.

BoxCushionType
Box cushion type options.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1114 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
Uniform Uniform cushion around box.
Nonuniform Non-Uniform cushion around box.

CalculationFrequency
No details are provided for this entry.

Possible Values
AllTimePoints
LastTimePoint
EquallySpacedTimePoints
SpecifiedRecurrenceRate
Never

CalculationType
The available analysis types for an analysis.

Possible Values
Static Computation of the system that is time inde-
pendent.
Modal Computation of the dynamic response of a
system under excitation
All All domains.

CandidatesColoringMethods
Enumeration of the Coloring methods used for Candidates chart.

Possible Values
ColoringPerPointType The color is used to distinguish the different
types of candidate points (Starting Points,
Candidate Points, etc).
ColoringPerOutputNature The color is used to distinguish the nature of
the output values (Response Surface or Simu-
lation).

CappingSurfaceConstructionMethod
Options for choosing selection method for capping surface.

Possible Values
CappingSurfaceFacesConstraint Construct capping surface by capping all
laminar loops of selected faces.
CappingSurfaceEdgesConstraint Construct capping surface by capping all loops
of selected edges.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1115
Data Types

CappingSurfaceLoopsConstraint Construct capping surface by capping all

specified loops.
CappingSurfaceVerticesConstraint Construct capping surface by capping the loop
formed by selected Vertices.

CasePrecision
Precision of FLUENT Session.

Possible Values
Single
Double

CCDTemplateType
Enumeration for the Template Type for CCD algorithm.

Possible Values
CCD_STANDARD_TEMPLATE Standard
CCD_ENHANCED_TEMPLATE Enhanced

CentralCompositeDesignType
Enumeration of the available design types for the Central Composite Design algorithm.

Possible Values
CCDTYPE_FACE_CENT Face-Centered
CCDTYPE_ROT Rotatable
CCDTYPE_VIF_OPT VIF-Optimality
CCDTYPE_G_OPT G-Optimality
CCDTYPE_AUTO Auto Defined

ChartAxes
The possible chart axes.

Possible Values
XAxis X axis
YAxis Y axis
ZAxis Z axis
XTopAxis Secondary X axis drawn at the top of the
chart.
YRightAxis Secondary Y axis drawn at the right of the
chart.
SweepAxis An axis used to sweep over an additional
parameter.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1116 of ANSYS, Inc. and its subsidiaries and affiliates.
ChartColoringMethods
Enumeration of the Coloring methods used for Tradeoff and Samples charts.

Possible Values
ColoringPerFront A different color for each Pareto fronts (several
samples have the same color).
ColoringPerSample A different color for each sample.

ChartStyle
Allowed styles of a multi-axis chart.

Possible Values
PCP Parallel Coordinate Plot
Spider Spider Plot

ChartType
Enumeration for the chart type.

Possible Values
ChartUnknown Unknown
ChartResponse Response
ChartTradeoff Tradeoff
ChartSamples Samples
ChartDistributions Distributions
ChartCorrelation Correlation
ChartSpiderResponses Spider
ChartLocalSensitivity Local Sensitivity
ChartSensitivities Sensitivities
ChartStatistics Statistics
ChartCorrelationScatter Correlation Scatter
ChartDesignPointsParallel Parameters Parallel
ChartDesignPointsCurves Design Points vs. Parameters
ChartDetermination Determination Matrix
ChartPredictedvsObserved Predicted vs. Observed
ChartDeterminationHistogram Determination Histogram
ChartConvergence Convergence
ChartLocalSensitivityCurves Local Sensitivity Curves
ChartCustom Custom Chart
ChartCandidates Candidates
ChartHistory History
ChartConvergenceCriteria History
ChartParameterRelationship History

ClearanceType
Enumeration of the tip clearance specification options.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1117
Data Types

Possible Values
None
RelativeLayer
AbsoluteLayer

ClearanceType
inpeller clearance type

Possible Values
Ratio tip clearance specified as a ratio
User tip clearance specified directly

ClearMessagesOption
Options when deleting messages.

Possible Values
KeepMessagesIfSourceMatched Do not delete message if its source matches
the specified one.
ClearMessagesIfSourceMatched Delete message if its source matches the
specified one.
ClearMessagesIfSourceNotMatched Delete message if its source does not match
the specified one.
IgnoreSource Do not check source attribute.

CollisionAvoidance
Used to specify the strategy to be used for avoiding collisions between inflated surface meshes. The
default value is StairStepping.

Possible Values
None No check for layer collisions.
LayerCompression Inflation layers are compressed in collision
areas.
StairStepping Prism layers are stair stepped to avoid collision
and maintain the gap defined by gap factor.

Color
This type represents a 32-bit Red/Green/Blue/Alpha color.

When working with Workbench Scripting, a color is represented as a four entry string in the form "R G
B A", where each entry is in the range 0-255. Alpha (A) is optional and will be set to 255 (opaque) if not
supplied. For example:

renderStyle1.LineColor = "255 0 0" # Sets the line to opaque Red.

renderStyle1.LineColor = "0 0 255 128" # Sets the line to translucent Blue.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1118 of ANSYS, Inc. and its subsidiaries and affiliates.
ComparePartsOnUpdateMethod
Compare parts on update options

Possible Values
ComparePartsMethod_None Do NOT compare parts on update -- default
value
ComparePartsMethod_Associatively Compare parts using associative mechanism,
if geometry interface is non-associative expect
failures in compare
ComparePartsMethod_NonAssociatively Compare parts using entity comparisons based
on index of second model to original attach

ComparePartsTolerance
Compare parts on update tolerance options

Possible Values
ComparePartsTolerance_Loose A greater loosening of the default tolerance
ComparePartsTolerance_Normal Looser tolerance than default to allow some
wiggle room for slight deviations
ComparePartsTolerance_Tight Default, existing behavior

ComponentConfigType
List of available component configurations

Possible Values
ImpellerMainOnly impeller (main blade only)
ImpellerOneSplitter impeller (main blade + 1 splitter)
ImpellerTwoSplitters impeller (main blade + 2 splitters)

ConductanceControlType
Switch to use program controlled conductance value or enter value.

Possible Values
ProgramControlled
Manual

ConnectionCreationMode
It tells if this connection was created automatically by the program or created manually by the user

Possible Values
Automatic
Manual

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1119
Data Types

ConstraintHandlingType
Enumeration of the Constraint Handling types.

Possible Values
AsGoals Relaxed constraint.
AsHardConstraints Strict constraint.

ConstraintType
Enumeration of the possible optimization constraint types.

Possible Values
CT_NoPreference No constraint defined.
CT_NearTarget Equals target.
CT_LessThanTarget Less than target.
CT_GreaterThanTarget Greater than target.
CT_InsideBounds Inside bounds.

ConstructionAlgorithm
Options for choosing construction algorithm for capping surface.

Possible Values
Delaunay Construct capping surface by using delaunay
triangulation.
FillHole Construct capping surface by using hole filling
algorithms.
ConvexHull Construct capping surface by using convex
hull approach.
Automatic Construct capping surface by choosing appro-
priate construction algorithm.

ContactDetectionPoint
Specify the location of contact detection to be used in the analysis in order to obtain a good convergence.

Possible Values
ProgramControlled
DetectOnGaussPoint
DetectNodalNormalFromContact
DetectNodalNormalToTarget
DetectNodalProjectedNormalFromContact

ContactPairOutputYesNo
Activate Contact Pair Output in MAPDL solution.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1120 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
kNo
kYes

ContactPhysicsSelection
Method for selecting the physics type: Program Controlled or Manual

Possible Values
ProgramControlled
Manual

ContactType
Type of contact for eg. Bonded, Frictional, Frictionless, etc.

Possible Values
Bonded
NoSeparation
Frictionless
Rough
Frictional

ConvectionMatrixType
Matrix type for the film coefficient: Diagonal or Consistent.

Possible Values
ProgramControlled
Diagonal
Consistent

CoordinateInputMethod
Options for definining vectors

Possible Values
Entry
Location

CoordinateSystemType
Enumeration to specify the coordinate system type for imported data.

Possible Values
Cartesian

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1121
Data Types

Cylindrical

CorrelationAutoStopType
Enumeration of the correlation Auto Stop types.

Possible Values
ExecuteAllSimulations Execute all Simulations.
EnableAutoStop Enable Auto Stop: execute Simulations iterat-
ively until the process converges or the max-
imum number of simulation specified is
reached.

CoupledAnalysisType
The valid coupling types

Possible Values
Undefined This is internal option used to cache the user
selection of analysis type. It cannot be spe-
cified by the user.
General Define the coupling by time steps
Transient Define the coupling by time intervals
Harmonic Define the coupling by frequency intervals.
The harmonic coupled analysis is not currently
supported.

CreateIntersectingEdgesForOverlappingBodies
Used to specify whether intersecting edges should be created for overlapping bodies. The default value
is No.

Possible Values
Yes
No

DampedSolverType
An enumeration for damped modal solver types as available from MAPDL solver.

Possible Values
ProgramControlled
FullDamped
ReducedDamped

DataContainerReference
A reference to a data container, similar to a DataReference referring to an entity.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1122 of ANSYS, Inc. and its subsidiaries and affiliates.
DataObject
Implements the virtual data model concepts for native C# code.

DataOrder
An enum of Row or Column which indicates if the Data is entered in a row-major or column-major order.
The default is Row.

Possible Values
Column Column-major
Row Row-major

DataReference
A Data Reference holds and manages a reference to a data entity in the Workbench data model.

DataReferenceSet
This type contains an ordered set of DataReferences. No modifications can be made to the contents.

DataTypeEnumeration
This enumeration represents all of the tensor types supported by the MPC variable.

Possible Values
AType An unknown type
Scalar A scalar
VectorXY A vector in x and y components
VectorYZ A vector in y and z components
VectorXZ A vector in x and z components
VectorXYZ A vector in x, y, and z components
VectorRA A vector in r and a components
VectorAZ A vector in a and z components
VectorRZ A vector in r and z components
VectorRAZ A vector in r, a, and z components
VectorRI A vector in r and i components
VectorIA A vector in i and a components
VectorRIA A vector in r, i, and a components
Tensor2XYZ A 2D tensor
Tensor4XYZ A 4D Tensor
SymTensor2XYZ A 2D symmetric tensor
SymTensor4XYZ A 4D symmetric tensor
AntisymTensor2XYZ An anti-symmetric tensor

DateTime
This type represents a date and time. The default format for printing a DateTime object is "DD/MM/YYYY
HH:MM:SS AMPM". Additional properties which can be examined on a DateTime object to extract extra
detail include Year, Month, Day, Hour, Minute, Second and Date.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1123
Data Types

DebugLevel
Debug levels for the log output. Increasing levels generates more detailed output in the log.

Possible Values
None No debug output
Level1 Level 1
Level2 Level 2
Level3 Level 3
Level4 Level 4
Level5 All Levels
Default Use Default Output Level

DeformationScaling
How much to deform the Results display

Possible Values
None
Actual
FiftyPercent
OneHundredPercent
TwoHundredPercent
FiveHundrenPercent
Custom

DelimiterType
Enumeration to specify the type of delimiter in imported data.

Possible Values
Comma
Semicolon
Space
Tab
UserDefined

DerivationType
The enum values for the Derivation property to use for the IsotropicElasticity values.

Possible Values
Unknown
YoungsModulusPoissonsRatio
ShearModulusPoissonsRatio
BulkModulusPoissonsRatio
YoungsModulusShearModulus
YoungsModulusBulkModulus

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1124 of ANSYS, Inc. and its subsidiaries and affiliates.
 BulkModulusShearModulus

DerivativeApproximationType
Enumeration for the derivative approximation type.

Possible Values
DA_CentralDifference Central Difference
DA_ForwardDifference Forward Difference

DeterminationCoefficientChartModes
Enumeration of the Determination Coefficient chart modes.

Possible Values
Linear Display linear determination coefficients.
Quadratic Display quadratic determination coefficients.

Dictionary<Key, Value>
This type represents a data dictionary, where a Key is used to access an associated Value. When used
in scripting, a dictionary is created or printed using the form
myDict = {key1:value1, key2:value2, ...}

Python functionality can be used to examine dictionary keys, test for key existence and perform other
useful operations on dictionaries.

The following example shows the use of dictionaries in a Workbench script:

>>> template1 = GetTemplate(

TemplateName="Fluid Flow",
Solver="CFX")
>>> system1 = template1.CreateSystem()
>>> solution1 = system1.GetContainer(ComponentName="Solution")
>>> cfxSolutionProperties1 = solution1.GetCFXSolutionProperties()
>>> currentProps = cfxSolutionProperties1.GetEntityProperties()
>>> for key in currentProps.Keys:
print "%s = %s" % (key, currentProps[key])

SolverCommandMode = Foreground
DisplayText = Solution Source
InitializationOption = CurrentSolutionData
LoadMResOptions = LastConfigOnly
ResultsFile = None
>>> myProps={"SolverCommandMode":"Background","InitializationOption":"InitialConditions"}
>>> cfxSolutionProperties1.SetEntityProperties(Properties=myProps)
# The above is equivalent to:
# cfxSolutionProperties1.InitializationOption ="InitialConditions"
# cfxSolutionProperties1.SolverCommandMode="Background"

DiffuserType
diffuser type

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1125
Data Types

Possible Values
Vaned vaned diffuser
Vaneless vaneless diffuser

DimensionsType
Enumeration to specify the dimensionality of imported data.

Possible Values
Dimension2D
Dimension3D

DirectionType
The direction the streamline is moving, relative to inlets and outlets

Possible Values
Backward
Forward

DistributionType
Enumeration of the possible parameter distribution types.

Possible Values
Uniform Uniform
Triangular Triangular
Gauss Normal
TruncGauss Truncated Normal
LogNorm Lognormal
Exponential Exponential
Beta Beta
Weibull Weibull

DotStyles
Styles of dot symbols. Default is none

Possible Values
None
Ellipse
Rect
Diamond
Hexagon
Triangle
DTriangle
UTriangle

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1126 of ANSYS, Inc. and its subsidiaries and affiliates.
 LTriangle
RTriangle
Cross
XCross
Star
Default

double
This type represents a double-precision floating point number.

DurationType
The methods used to specify duration

Possible Values
NumberOfSteps The coupling will end at a given number of
steps
EndTime The coupling will end at a given time

EDesignPointScope
This describes specific groups of design points and is used by some commands that can work on a
variable number of design points EPS_CURRENT - current design point in parameter manager
EPS_PARAMETER_MANAGER - the parameter manager design point table EPS_DOE - parameter table
built from all the DOE components that enable parameters associated with the system in question
EPS_ALL - the combination of design points obtained by using the rules used for EPS_ALL and
EPS_PARAMETER_MANAGER

Possible Values
EPS_CURRENT
EPS_PARAMETER_MANAGER
EPS_DOE
EPS_ALL

EdgeSizingMethod
Used to specify if the edge sizing should be based on the element size or on the number of divisions.

Possible Values
ElementSize
EdgeDivisions

EffType
Impeller efficiency type

Possible Values
Automatic Efficiencies calculated from correlations

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1127
Data Types

Hydraulic Hydraulic efficiency calculated. Volumetric,

mechanical and overall pump efficiencies user
defined.
Volumetric Volumetric efficiency calculated. Hydraulic,
mechanical and overall pump efficiencies user
defined.
Mechanical Mechanical efficiency calculated. Hydraulic,
volumetric and overall pump efficiencies user
defined.
Pump Overall pump efficiency calculated. Hydraulic,
volumetric and mechanical efficiencies user
defined.

ElementMidsideNodes
Used to define whether elements are created with or without midside nodes. The default value is
UseEngineeringIntent.

Possible Values
UseEngineeringIntent Determine whether midside nodes are kept
or dropped based on the Engineering Intent.
Dropped Elements are created without midside nodes.
Kept Elements are created with midside nodes.

ElementShape
Used to specify the mesh element shape for the bodies associated with this control.

Possible Values
Automatic
Tetrahedrons
Hexahedrons

EngineeringDataType
Supported types of engineering data.

Possible Values
Unknown
Material
Load
BeamSection
Mixture

EngineeringIntent
Used to define the kind of physics that is being studied in this simulation process (used in part-based
Meshing).

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1128 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
Unknown Intent of this process is not yet known due to
insufficient information in connected Physics
task(s).
StructuralOrThermalOrElectricConduction Intent of this process is a structural, electric
conduction and/or thermal simulation.
FluidFlow Intent of this process is a fluid flow simulation.

EntityType
Available expression entity types

Possible Values
Node
Face
Element
Edge

EquationSolverType
Equation Solver Types as available from MAPDL solver.

Possible Values
ProgramControlled
Direct
Iterative
Unsymmetric
Supernode
Subspace

EtaCorrelType
Efficiency correlation type

Possible Values
CaseyRobinson Casey-Robinson correlation
CaseyMarty Casey-Marty correlation
Rodgers Rodgers correlation

EtaCorrelType
Efficiency correlation type

Possible Values
Suhrmann Suhrmann's correlation
Baines Baines' correlation

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1129
Data Types

EtaImpType
impeller isentropic efficiency type

Possible Values
LinkToStage linked to stage efficiency
User user specified efficiency

EtaType
Stage efficiency type

Possible Values
User User defined efficiency
Correlation Efficiency calculated from correlation

EtaType
Stage efficiency type

Possible Values
User User defined efficiency
Correlation Efficiency calculated from correlation

EtaUserType
User specified stage efficiency type

Possible Values
Isentropic user-specified isentropic efficiency
Polytropic user-specified polytropic efficiency

ExcelConnectionState
Enumeration for the Excel Connection states

Possible Values
NotConnected The connection with Excel is not established
ConnectionAlive The connection is alive
ConnectionLost The connection has been lost

ExecutionControlConflictOptions
Options for handling execution control conflicts on Edit

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1130 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
Default
UseSetupExecutionControl
UseSetupExecutionControlAlways
UseSolutionExecutionControl
UseSolutionExecutionControlAlways

ExecutionControlSource
Enumeration for the execution control conflict resolution.

Possible Values
IssueWarning
UseExecutionControlFromSetup
UseExecutionControlFromSolution

ExitAngleType
Exit angle type

Possible Values
Absolute Absolute exit angle
Relative Relative exit angle

Expression<Type>
The Expression type is used to hold an expression that returns a result of a given type or a result in a
homogenous vector of the given type.

ExpressionType
Specifies the possible types of parameter expression.

Possible Values
Undefined An undefined(null) expression.
Constant An expression without dependency on other
parameter.
Derived An expression with dependency on other
parameters.

FileType
File Types recognized by FLUENT. Includes native FLUENT files as well as files that FLUENT can import
or export. The Unknown File Type is used when FLUENT is unable to recognize the file type.

For more details on the file types recognized by FLUENT, please refer to the FLUENT User's Guide.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1131
Data Types

Possible Values
Mesh
Case
Data
Bc
Pdf
S2s
Flamelet
Dtrm
Udf
Udflib
UdfSource
Wave
SurfaceMonitors
VolumeMonitors
ParticleInjections
BoundaryProfile
SolutionTranscript
SchemeFile
JOUFile
FluentResidualFile
InterpolateDataFile
registeredTypes
AbaqusFilbin
AbaqusInput
AbaqusOdb
Ansys
AnsysResults
CfxDefn
CfxResults
Cgns
CgnsMeshData
Ensight
Fidap
Fluent4
FluentMesh
Gambit
Hypermesh
IdeasUniv
LstcInput
LstcState
MarcPost
Mechanica
MetisCase
MetisZoneCase
Nastran
NastranOutput
PamDaisy
Patran
PatranResults
Pda

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1132 of ANSYS, Inc. and its subsidiaries and affiliates.
 Prebfc
Plot3dGrid
Plot3dResults
StlAscii
StlBinary
TecplotBinary
VkiGeneric
Unknown

FillStyles
Style of any filled region. The default is None.

Possible Values
None
Solid
Dense
Medium
Sparse
Horizontal
Vertical
Cross
BDiagonal
FDiagonal
CrossDiagonal
Gradient
Default

FittingType
Enumeration for the Response Surface type.

Possible Values
FITTINGTYPE_SRS Standard Response Surface - Full second order
Polynomials
FITTINGTYPE_KRIGING Kriging
FITTINGTYPE_MARS Non Parametric Regression
FITTINGTYPE_NN Neural Network
FITTINGTYPE_SPARSEGRID Sparse Grid

FixFirstLayer
Used to specify whether the heights or ratios of the first inflation layer will be modified to avoid collision.
The default value is No.

Possible Values
Yes
No

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1133
Data Types

FlowType
Enumeration of the flow boundary condition options.

Possible Values
MassFlow
PressureRatio
PressureDifference

FluidType
Enumeration of the types of available fluids.

Possible Values
IdealGas
RealGas
Liquid

FormatType
Enumeration to specify the format type for imported data.

Possible Values
UserDefined
Delimited
Cdb
Axdt

FormulationType
Set the contact formulation to be used by the solver for a particular contact pair.

Possible Values
ProgramControlled
MultiPointConstraint
PurePenalty
NormalLagrange
AugmentedLagrange

GasModelType
gas model type

Possible Values
Ideal ideal gas model
Real real gas model

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1134 of ANSYS, Inc. and its subsidiaries and affiliates.
GasPropType
Gas properties type

Possible Values
Air Gas props - Air
AFR Gas props - Air/fuel ratio
Fixed Gas props - Fixed

GeometryAnalysisType
3D/2D Geometry import option

Possible Values
Type3D Import all 3D objects
Type2D Import only 2D objects (The model must be
in the x-y plane.)

GeometryAttachType
Type of geometry that is being attached.

Possible Values
ThreeDimensional
TwoDimensional
Unknown

GeometryStyleType
Geometry export style type

Possible Values
Interactive Create interactive geometry
Parametric Create parametric geometry

GoalType
Enumeration of the possible optimization objective types.

Possible Values
GT_NoPreference No objective defined.
GT_MaximumPossible Maximize.
GT_MinimumPossible Minimize.
GT_SeekTarget Seek target.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1135
Data Types

GPUAccelerator
Enumeration for the graphics acceleration library to be used by the Mechanical APDL editor.

Possible Values
None
Amd
Intel
NVIDIA

GrowthRateType
Determines height of inflation layers for given initial height and height ratio. The default value is Geo-
metric.

Possible Values
Exponential Height of inflation layer determined exponen-
tially.
Geometric Height of inflation layer determined geomet-
rically.
Linear Height of inflation layer determined linearly.

HubLEBetaType
Hub and Mean LE blade angle option

Possible Values
Cot Hub/Mean LE blade angle calculated using
cotangent (rel to Shroud LE beta)
Cos Hub/Mean LE blade angle calculated using
cosine (rel to Shroud LE beta)
User User defined hub and mean LE blade angles

ICCombustionSimulationType
Type of IC Engine Combustion simulation type.

Possible Values
ICSector 0 for sector
ICFullEngineFullCycle 1 for full engine full cycle
ICFullEngineClosedValves 2 for full engine IVC to EVO

ICIVCandEVOoption
IVC and EVO options

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1136 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
ICLiftCurv 0 lift curv profile
ICIVCandEVO 1 for IVC EVO option

ICSimulationType
Type of IC Engine Simulation.

Possible Values
ICSimulationColdFlow 0 for Cold Flow Simulation
ICSimulationPortFLow 1 for Port Flow Simulation
ICSimulationCombustion 2 for Combustion Flow Simulation

IDHandling
The ID handling property for the current object.

Possible Values
None No action must be carried out when renum-
bering the attributes of the current object.
Automatic The IDs of the attributes of the current object
must be automatically renumbered so that no
conflicts will happen.
Unknown The ID Handling property is not set.

ImpellerExportType
Impeller export type

Possible Values
Coupled Coupled to volute
Isolated Isolated impeller

ImpellerLengthType
impeller length ratio type

Possible Values
Automatic automatic
User user specified

ImpellerType
impeller type

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1137
Data Types

Possible Values
Unshrouded unshrouded impeller
Shrouded shrouded impeller

ImportanceLevel
Enumeration of the importance levels which can be associated with an optimization objective or con-
straint.

Possible Values
GI_MediumImportant Default
GI_LowImportant Lower
GI_HighImportant Higher

ImportWeightclass
Preference for imported weightclass, could be used for identifying weightclasses of imported parts

Possible Values
ImportWeightclass_Heavyweight Heavyweight - all geometry and topology
ImportWeightclass_Middleweight Middleweight - facet only faces
ImportWeightclass_Lightweight Lightweight - each body consists of a single
facetted face
ImportWeightclass_Featherweight Featherweight - parts are created along with
the tree hierarchy, but no topology

IncidenceType
Incidence type

Possible Values
incidence specified incidence
choke specified choke

InflationAlgorithm
Used to specify if pre or post inflation algorithm should be used by the mesher. The default value is
Pre.

Possible Values
Post
Pre

InflationOption
Used to specify the way heights of the inflation layers are determined. The default value is
SmoothTransition.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1138 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
TotalThickness Creates constant inflation layers using the
values of Number of Layers and Growth Rate.
FirstLayerThickness Creates constant inflation layers using values
of First Layer Height, Maximum Layers and
Growth Rate.
SmoothTransition Mesher ensures smooth rate of volume change
using local tetrahedral element size.
FirstAspectRatio Creates inflation layers using values of First
Aspect Ratio, Maximum Layers and Growth
Rate.
LastAspectRatio Creates constant inflation layers using values
of First Layer Height, Maximum Layers and
Aspect Ratio.

InitializationMethods
Initilization Methods

Possible Values
ProgramControlled
SolverControlled
ProvideInitialSolution

InitializationOption
Enumeration for the Solution update initialization options.

Possible Values
CurrentSolutionData
InitialConditions

InitializationType
The initialization settings

Possible Values
ProgramControlled Program Controlled
StartTime Start Time
RestartStepTime Restart Step and Time

InletAngleType
Inlet angle type

Possible Values
Absolute Absolute inlet angle

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1139
Data Types

Relative Relative inlet angle

Calculated OBSOLETE OPTION. RETAINED IN R16.0 FOR
PURELY FOR BACKWARDS COMPATIBILITY
Calculated from nozzle area

int
This type represents an Integer number.

long
This type represents a long (64-bit) Integer number.

IntegrationType
IntegrationType of elements used by solvers such as Full or Reduced.

Possible Values
Unknown
ProgramControlled
Full
Reduced

InterfaceBehavior
InterfaceBehavior is an abstraction over all kinds of interface behaviors such as JointBehavior, BeamBe-
havior, LinkBehavior, SpringBehavior and ContactBehavior.

InterfaceBehaviorCreation
It allows you to create one connection behavior and share it or create separate ones for each one of
searched interfaces.

Possible Values
Shared
Individual

InterfaceToleranceSpecification
It allows to let either program decides the tolerance value for you or you choose to input your own
tolerance value

Possible Values
Automatic
Manual

InterfaceType
Type of inerfaces to be generated. Select from Contact, Joint and Mesh Interface.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1140 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
None
Contact
Joint
MeshInterface

IsotropicElasticityDependents
Used when IsotropicElasticity is constant for all independent variables (e.g. Temperature).

IsovalueMethod
Specifies how to obtain the isovalues for the isosurface

Possible Values
Manual
Automatic

JobRunMode
The job running modes

Possible Values
Foreground Forground mode.
Background Background mode.
RemoteSolveManager Submitted to Remote Solve Manager to run
the job.

KernelVariationType
Enumeration of the Kernel Variation types.

Possible Values
VARIABLE Variable
CONSTANT Constant

LegendColoring
Types of allowed legend coloring.

Possible Values
Banded
Smooth

LinearCorrelationType
Enumeration of the Correlation types.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1141
Data Types

Possible Values
Spearman Spearman
Pearson Pearson

LineStyles
Styles of lines that can be displayed. The default is Solid.

Possible Values
None
Solid
Dense
Medium
Sparse
DashShort
DashMedium
DashLong
DashDot
DashDotDot
DashDashDot
Gradient
Default

List<Type>
This type represents an unordered list of values.

LocalElementMidsideNodes
Used to specify if the elements created for the bodies associated with this control should have midside
nodes or not. The default value is UseGlobalSettings.

Possible Values
UseGlobalSettings
Dropped
Kept

LocationSet
An immutable class representing a set of locations

A Location is a key value pair of a model reference string and Point3DUnited (coordinate of the hit
point on the model).

The order of the locations is maintained for the lifetime of the object.

In script a LocationSet is represented in one of the following forms:

Model reference strings ["BODY1", "FACE5"]

Objects with LocationSet [selectionSet1, selectionSet2]

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1142 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model reference string with hit point [('FACE13', ('0.062 [m]', '0.197 [m]', '0.35
[m]')),('FACE23', ('0.07 [m]', '0.569 [m]', '0.502
[m]'))]
LocationSet returned from a function AllBodies()

MachineSpecification
List of computers to be used for a parallel FLUENT session. The list can be specified directly, or a hosts
file containing the list can be specified.

For more details on how to specify the machines to be used for a parallel FLUENT session, please refer
to the FLUENT User's Guide.

Possible Values
MachineList
FileName

MachineType
Setup Entity enum definition for machine type

Possible Values
Pump Pump
AxialCompressor Axial Compressor
CentrifugalCompressor Centrifugal Compressor
Fan Fan
AxialTurbine Axial Turbine
RadialTurbine Radial Turbine
HydraulicTurbine Hydraulic Turbine
Unknown Undefined machine type
Other Obsolete option, use 'Unknown' instead.

MAPDLSolverMode
Run the solver in batch mode just while solving or keep it live.

Possible Values
Live
Batch

Material
The material object holds all information that defines the behavior for a specific material.

MaterialAssignment
Assigns a Material to a specified Location.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1143
Data Types

MaterialNamesList
Database materials list Note that this is currently a fixed list which must correspond to the vistaFluids.xml
database

Possible Values
Air Air
CarbonDioxide Carbon dioxide
Hydrogen Hydrogen
Methane Methane
Nitrogen Nitrogen
Oxygen Oxygen
Parahydrogen Parahydrogen
Propylene Propylene
R123 R123
R125 R125
R134a R134a
R141b R141b
R142b R142b
R245fa R245fa
Water Water

MaterialPropsType
material properties type

Possible Values
Database select material from database
User user specified material properties

MeshBasedDefeaturing
Used to specify the type of automatic defeaturing for dirty geometries. The default value is Automatic-
allyDetermined.

Possible Values
AutomaticallyDetermined Automatically removes features smaller than
or equal to the calculated default tolerance
value on dirty geometry.
UserDefined Automatically removes features smaller than
or equal to the user defined defeaturing toler-
ance value on dirty geometry.
Off No defeaturing done on dirty geometry.

MeshFileType
MeshFileType is used to identify the format of the mesh data file. This is usually the same as the applic-
ation that generated the data file.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1144 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
CFX
ICEM_CFD
FLUENT
POLYFLOW
Unknown

MeshMetric
Used to specify the metric type based on which mesh quality is evaluated. The default value is None.

Possible Values
None No mesh metric type is selected.
ElementQuality A composite quality metric is computed ran-
ging between 0 and 1.
AspectRatio Aspect ratio is calculated based only on corner
nodes of elements.
JacobianRatio Jacobian ratio is computed for all elements
except those with no midside nodes or per-
fectly centered midside nodes.
WarpingFactor Warping factor is computed for quadrilateral
shell elements and quadrilateral faces of
bricks, wedges and pyramids.
ParallelDeviation Parallel deviation is computed ignoring mid-
side nodes and based on unit vectors along
each element size.
MaximumCornerAngle Maximum corner angles are computed
between adjacent edges and high corner
angles can degrade element performance.
Skewness Skewness is one primary quality measure that
determines how close to ideal (that is, equilat-
eral or equiangular) a face or cell is.
OrthogonalQuality Orthogonal quality is computed using face
normal vectors and ranges from 0 to 1.

MeshReading
Indicates the type of restart.

Possible Values
Direct In this mode, one loads directly the mesh (no
conversion).
Convert In this mode, one converts the *.poly or fluent
*.msh into a polyflow *msh file

MeshRestartMode
Indicates the type of mesh import we want : - no initialization from upstream system - select a mesh
in a list of mesh files coming from an upstream polyflow system

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1145
Data Types

Possible Values
NoUpstreamMeshFile in this mode, no mesh file is selected from the
upstream polyflow system.
SingleMeshFile in this mode, a mesh file is selected from a
list of meshes coming from the upstream
polyflow system.

MessageType
The valid message types.

Possible Values
Information An informational message for the user.
Warning A warning message for the user.
Error An error message for the user.
Fatal A fatal message for the user. On receiving a
message of this type, the framework will show
the message to the user, and then exit imme-
diately, without giving any chance to save
their work or shut down running processes.
Problems Problem messages (WARNING + ERROR +
FATAL).
Debug A debug message.
Progress A progress message for the user.
News A news update for the user.
AttentionRequired A message that requires user action to address
Standard All non-debug and non-progress messages.

Method
The method used to create the Single Value Result

Possible Values
FunctionCalculatorMethod
UserDefinedExpressionMethod

Metric
Used to specify the measure to be used for improving the mesh quality. The default value is Skewness.

Possible Values
Skewness
SizeChange
AspectRatio

MixedImportPref
Mixed import preference option for mixed dimension parts

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1146 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
MixedImport_None If mixed dimension part, import None
MixedImport_Solids If mixed dimension part, import Solids only
MixedImport_Surfaces If mixed dimension part, import Surfaces only
MixedImport_Lines If mixed dimension part, import Lines only
MixedImport_SolidsAndSurfaces If mixed dimension part, import Solids and
Surfaces only
MixedImport_SurfacesAndLines If mixed dimension part, import Surfaces and
Lines only

MixedResolutionType
Defines the mixed resolution option during geometry import.

Possible Values
None
Solid
Sheet
Wire
Point
SolidSheet
SolidWire
SolidPoint
SheetWire
SheetPoint
WirePoint
SheetWirePoint
SolidWirePoint
SolidSheetPoint
SolidSheetWire
All

ModelType
The type (format) of the model, either from files or data from other systems.

Possible Values
Abaqus The model is formatted according to the
ABAQUS standard.
CFX The model is formatted according to the CFX
standard.
CMDB The model is stored in a Meshing database.
Fluent The model is formatted according to the Flu-
ent standard.
Icem The model is formatted according to the Icem
standard.
MechAPDLCDB The model is formatted according to the CDB
standard, used in Mechanical APDL.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1147
Data Types

Nastran The model is formatted according to the

Nastran standard.
SimulationSetup The model is stored in a Simulation database.
STL The model is formatted according to the STL
standard.
ACMO The model is stored in an ACMO database.
MechAPDLRST The model is formatted according to the RST
standard, used in Mechanical APDL.
AbaqusResults The model is formatted according to the res-
ults standard used in ABAQUS.
NastranResults The model is formatted according to the res-
ults standard used in Nastran.
SamcefResults The model is formatted according to the res-
ults standard used in Samcef.
FEModeler Internally used to specify a FE Modeler to FE
Modeler connection.
Unknown The model type property is not set.

MonitorChartType
MonitorChartType enum: Residual or UserDefined

Possible Values
Residual
UserDefined

MPIType
Enumeration for the MPI library to be used by the Mechanical APDL solver.

Possible Values
Undefined
PCMPI
MSMPI
IntelMPI

MResOptions
Enumeration for the load options for Multi-configuration Results.

Possible Values
AllConfigsSingleCase
AllConfigsSeparateCases
LastConfigOnly

NodeAndElementRenumberingMethodType
No details are provided for this entry.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1148 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
None
Offset
Automatic

NumSampType
Enumeration to specify for the samples type for OSFD algorithm.

Possible Values
SFD_CCD CCD samples
SFD_LINEAR Linear model samples
SFD_PUREQUAD Pure quadratic model samples
SFD_CROSSQUAD Full quadratic model samples
SFD_USER User-defined samples

NuUserType
kinematic viscosity calculation type (obsolete)

Possible Values
Sutherland calculate viscosity from Sutherland's Law (us-
ing coeffs for air)
User user specified kinematic viscosity

Object
This type can represent any generic object. It is used when any type is a valid value.

ObjectRenamingType
No details are provided for this entry.

Possible Values
Off
BasedOnCellId
BasedOnSystemName
BasedOnUserInput

ObjectRenamingType
No details are provided for this entry.

Possible Values
Off
BasedOnCellId
BasedOnSystemName

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1149
Data Types

BasedOnUserInput

OnOffSwitch
This property specifies if a given mode should be turned on or not (used in distributed solve).

Possible Values
kOn
kOff

OpeningPositionMethod
Enumeration of the inlet/outlet placement options.

Possible Values
Manual
AdjacentBlade

OptimalSpaceFillingType
Enumeration of the available design types for the Optimal Space Filling algorithm.

Possible Values
SFDTYPE_MDIST Max-Min Distance
SFDTYPE_CL2 Centered L2
SFDTYPE_MAXENT Maximum entropy

OrientationStyle
Allowed orientation of a legend. Default is Vertical

Possible Values
Vertical
Horizontal
Default

Output<Type>
The Output type is used in select instances where a method returns additional information in a method
argument as well as the method return. These output arguments are typically optional, and a output
variable must be declared before it is used. Once assignment has been made to an output variable, the
return value can be evaluated by using the Get() method on the variable.

The following example shows the declaration and use of an output argument.

>>> template1 = GetTemplate(TemplateName="EngData")

>>> system1 = template1.CreateSystem()
>>> engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
>>> matl1 = engineeringData1.GetMaterial(Name="Structural Steel")

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1150 of ANSYS, Inc. and its subsidiaries and affiliates.
 >>> matlProp1 = matl1.GetProperty(Name="Density")
>>> matlProp1.SetData(
>>> Variables="Density",
>>> Values="-10 [kg m^-3]")
>>> from Ansys.Core.Commands import Output
>>> outMsg = Output[str]()
>>> if not matl1.IsValid(Message=outMsg):
>>> print "Material is not valid for the following reason:"
>>> print outMsg.Get()
Material is not valid for the following reason:
The value(s) for Density must be greater than zero.

OutputFrequencyType
The entitry stores the options to specify frequency of writing result files

Possible Values
None No intermediate result files
EveryStep Every Coupling Step
StepInterval At defined interval

OutputSource
Source of the output values, indicating the method used to obtain them.

Possible Values
UserEdited The output values are edited by the user.
Simulation The output values are obtained by a real sim-
ulation.
ResponseSurface The output values are obtained by evaluating
a response surface approximation.

OutputType
OutputType for OutputSpecification such as Deformation, Stress or Strain

Possible Values
None
All
Basic
NodalDofSolution
NodalReactionLoads
NodalVelocity
NodalAcceleration
ElementSolution
ElementNodalLoads
ElementNodalStresses
ElementElasticStrains
ElementThermalStrains
ElementPlasticStrains
ElementCreepStrains

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1151
Data Types

ElementDiffusionStrains
ElementNodalGradients
ElementNodalFluxes
IntegrationPointLocations
StateVariables
ElementMiscellaneousData

ParameterizedEntityPropertiesCollection
A ReadOnlyDictionary for parameterized properties. The keys are the data references to the entities that
hold the properties, the values are the list (one or more) of the parameterized properties.

ParameterNature
Enumeration of the possible nature of a parameter.

Possible Values
NatureContinuous Continuous
NatureUsability Obsolete. Instead of defining a usability para-
meter, define a continuous parameter with
the UseManufacturableValues set to True.
NatureDiscrete Discrete

ParameterRelationshipType
Enumeration of the possible parameter relationship types.

Possible Values
PRT_LessThanOrEqualTo Less Than or Equal To
PRT_GreaterThanOrEqualTo Greater Than or Equal To

ParameterUsage
Specifies the possible ways a parameter can be used or set within the data model.

Possible Values
Input A parameter whose value will be used by the
data model.
ExpressionOutput An output parameter whose value is based
on an expression. The parameter cannot be
associated directly with the data model.
DirectOutput A parameter whose value will be provided
directly by the data model. The parameter
expression has to be undefined(null).

ParameterValueType
Type of a parameter value.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1152 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
ActualValue The actual value of the parameter.
VariationToReference The variation of the parameter with respect
to the current reference point, as a decimal
number.

PeriodicSurfType
Enumeration of the periodic surface options.

Possible Values
OnePiece
ThreePieces

PhysicsRegion
Specifies the type and location of the fundamental physics in the simulation.

PhysicsType
The available physics types for an analysis.

Possible Values
Unknown Indicates physics type was never set
None Indicates physics type was set and then
cleared
Structural A mechanical analysis determines the displace-
ments, stresses, strains, and forces in struc-
tures or components caused by loads that do
not induce significant inertia and damping
effects. Steady loading and response condi-
tions are assumed; that is, the loads and the
structure's response are assumed to vary
slowly with respect to time.
ElectricConduction An electric analysis supports Steady-State
Electric Conduction.
Fluid A fluids analysis can simulate the behavior of
liquids or gases within and around a structure
using boundary conditions.
Thermal You can use a thermal analysis to determine
temperatures, thermal gradients, heat flow
rates, and heat fluxes in an object that are
caused by thermal loads.
Manufacturing Simulation of molten polymers or molten
glass, for extrusion, blow molding, thermoform-
ing, pressing processes (in the laminar regime).
The fluid can be modeled by a generalized
newtonian law or by a viscoelastic law. Gener-

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1153
Data Types

ally, it involves some deformation (needing

remeshing) of the flow domain.
All All physics types.

PIFType
power input factor type

Possible Values
Correlation correlation
User user specified

Plane
The analytic definition of a flat plane where the Z axis is the normal direction.

PlaneConstructionMethod
Option for defining the plane construction method

Possible Values
OriginAndOrientation
FromPlane
FromReferenceFrame

PlaneOption
Options for selecting a Reference Frame plane.

Possible Values
XY
YZ
ZX

Point
Point represented by local coordinates relative to a reference frame.

Point3DUnited
Represents a three dimensional point using double precision.

PointCalculationMethod
Options for calculating a point from geometry selection

Possible Values
Centroid

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1154 of ANSYS, Inc. and its subsidiaries and affiliates.
 HitPoint

PositionType
Specifies the possible positions of a system when it is moved or created. These positions are relative
to an existing system, which is specified in a separate argument.

Possible Values
Default Default position. It is a new "child" of position,
by system if given, or a new "root" system
otherwise.
Left Positioned left to a system.
Right Positioned right to a system.
Above Positioned above a system.
Below Positioned below a system.

PostReportNamesType
CFD Post reports

Possible Values
None
AxialCompressorReport
AxialCompressorRotorReport
CentrifugalCompressorReport
CentrifugalCompressorBladeRowReport
CentrifugalCompressorRotorReport
TurbineReport
TurbineRotorReport
FanNoiseReport
FanReport
GenericReport
HydraulicTurbineReport
HydraulicTurbineRotorReport
PumpReport
PumpImpellerReport
StatorReport
TurbineStatorReport
Custom

PreswirlType
Preswirl type

Possible Values
constant Constant inlet angle
free Free vortex
forced Solid body rotation
linear Linear variation of Vw

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1155
Data Types

PreswirlType
Preswirl type

Possible Values
constant Constant inlet angle
free Free vortex
forced Solid body rotation

PrimitiveBoxCreationMethod
Box creation method options.

Possible Values
VirtualPrimitiveBoxByEntity Box can be created by enclosing single or
multiple entities.
VirtualPrimitiveBoxByCoordinate Box can be created by specifying diagonal
coordinates.

ProcessorUnit
Various Processore Unit options available for Microsoft Scheduler

Possible Values
Core
Socket
Node

ProximitySizeFunctionSources
Used to specify the source type to be used for size function calculation when Advanced Size Function
is Proximity or Curvature and proximity. The default value is Faces.

Possible Values
Faces
Edges
FacesAndEdges

Quantity
This class represents a physical quantity that can be measured. It holds a double value and a string that
specifies the value's unit of measurement. The Value and Unit can be accessed individually as properties
on this type, and a Quantity can be converted to new units.

Mathematical operations can also be performed on Quantities, and these operations calculate and enforce
dimensional consistency between units. Note the results of mathematical operations are always converted
into the project unit system.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1156 of ANSYS, Inc. and its subsidiaries and affiliates.
RampingType
Enum providing ramping options.

Possible Values
None No ramping.
Linear Linear profile ramping.

ReadOnlyDictionary<Key, Value>
This type represents a read-only data dictionary, where a Key is used to access an associated Value.
When used in scripting, a dictionary is created or printed using the form
myDict = {key1:value1, key2:value2, ...}

Python functionality can be used to examine dictionary keys, test for key existence and perform other
useful operations on dictionaries; however, the contents may not be manipulated unless the dictionary
or its contents are cloned into a regular dictionary.

RealGas
Enumeration of the available real gas materials

Possible Values
Air
CarbonDioxide
Hydrogen
Methane
Nitrogen
Oxygen
Parahydrogen
Propylene
R123
R125
R134a
R141b
R142b
R245fa
Water
Custom

RefDiameterType
Enumeration of the reference diameter options.

Possible Values
Automatic
User

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1157
Data Types

ReferenceFrame
Frame of reference for modeling and simulation data.

ReferenceFrameDefinitionType
Options for reference frame definition types

Possible Values
OriginAndOrientation
CoincidentWithParent
Transform

ReferenceTopologyType
Defines the topology type for a given reference.

Possible Values
RTT_NoTopology
RTT_Vertex
RTT_Edge
RTT_Face
RTT_Body
RTT_Part
RTT_Assembly
RTT_ConfigurationComponent
RTT_Invalid

RegionBehavior
Used to specify the meshing region behavior. Currently, the only possible value is Wrap.

Possible Values
Wrap Simplifies unclean geometry before sewing.

RelativeToType
Options for selecting a which reference frame to define relative to

Possible Values
Local
Parent

RepositoryFileInfo
Class to specify a repository file

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1158 of ANSYS, Inc. and its subsidiaries and affiliates.
ResponseChartModes
Enumeration of the available Response chart modes.

Possible Values
Curve2D 2D response chart where an output parameter
is plotted versus an input parameter.
Surface3D 3D response chart where an output parameter
is plotted versus two input parameters.
Slices2D 2D response chart where an output parameter
is plotted versus two input parameters, on the
X axis and the other varying over several
curves.

ResponseSurfaceRefinementType
Enumeration for the Refinement type.

Possible Values
REFINEMENT_NONE None
REFINEMENT_AUTO Automated
REFINEMENT_MANUAL Manual

ReverseEdgeLoopOrientation
Options for choosing loop orientation. Required only if construction algorithm is convex hull.

Possible Values
No Construct capping surface by using default
loop orientation.
Yes Construct capping surface by reversing loop
orientation.

RigidTransformOptions
No details are provided for this entry.

RigidTransformOptions
No details are provided for this entry.

RotationType
Enumeration of the machine rotational direction options.

Possible Values
RightHanded
LeftHanded

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1159
Data Types

RoughnessType
surface roughness type

Possible Values
Machined machined surface finish
Cast cast surface finish

RshSpecification
Client used to connect to the nodes in a cluster of LINUX machines.

'Other' is used for a custom connect command.

Possible Values
RSH
SSH
Other

SampleGenType
Enumeration for the Sampling type.

Possible Values
SAMPLE_GEN_LHS LHS
SAMPLE_GEN_WLHS WLHS

SamplesChartModes
Enumeration of the available Samples chart modes.

Possible Values
Candidates Draw the samples and highlight the optimiza-
tion candidates.
ParetoFront Draw the samples using colors that represent
their Pareto front.

Scale
Enum to define the scale of the axis.

Possible Values
Linear Linear scale
CommonLog Common or log base 10 scale
NaturalLog Natural log scale

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1160 of ANSYS, Inc. and its subsidiaries and affiliates.
Scale
Enum to define the scale of the axis.

Possible Values
Linear
CommonLog
NaturalLog

SchedulerSpecification
Various Job Schedulers available on Unix/Linux.

Possible Values
LSF
SGE
PBSPro

SearchPosition
A filter that can be applied to the SearchString used by GetAllObjects query.

Possible Values
Exact
Contains
StartsWith
EndsWith

SeedPointDistributionType
Allowable values for seed point sampling.

Possible Values
UniformSample
GridSample
Mesh

SeedPointMeshDistributionType
Allowable values for how mesh is evaluated when sampling seed points.

Possible Values
EveryNthElement
EveryNthVertex

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1161
Data Types

SensitivityChartModes
Sensitivity chart modes.

Possible Values
BarChart 2D Bar chart
PieChart 2D Pie chart

ShapeChecking
Used to define the shape checking algorithm to be used by the mesher. The default value is UseEngin-
eeringIntent.

Possible Values
UseEngineeringIntent Determine which algorithm to use based on
the Engineering Intent.
StandardMechanical Specifies the standard mechanical shape
checking algorithm for structural simulations.
AggressiveMechanical Specifies the aggressive mechanical shape
checking algorithm for structural simulations.
CFD Specifies the CFD shape checking algorithm
for flow simulations.
None Disable shape checking.

ShrLEBetaType
Shroud LE blade angle option

Possible Values
Incidence Shroud LE blade angle calculated from spe-
cified incidence
User User defined shroud LE blade angle

ShroudDiameterType
shroud diameter type

Possible Values
Diameter user specified shroud inlet diameter
Angle user specified shroud vane inlet angle
Optimum optimised shroud inlet diameter (minimum
Mrel)

SimulationType
Enumeration of the simulation types of a parameter.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1162 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
DesignVariable Design variable
UncertaintyVariable Uncertainty variable

float
This type represents a single-precision floating point number.

SixSigmaTableTypes
Enumeration of the Probability Table types.

Possible Values
ProbabilityTable Quantile-percentile
InverseProbabilityTable Percentile-quantile

SizingBehavior
Used to specify whether size control settings can be changed by the mesher (Soft) or not (Hard).

Possible Values
Soft
Hard

Smoothing
Used to specify the level of smoothing iterations to be performed. The default value is Medium.

Possible Values
Low
Medium
High

SolverRestartMode
Indicates the type of restart.

Possible Values
NoRestartFile In this mode, no restart file is used to initialize
time scheme and fields.
SingleResultFile In this mode, a result file is used to initialize
fields.
CombineResultRestartFiles In this mode, a result file is used to initialize
fields and a restart file is used to initialize time
scheme (starting time + derivates).
SingleCsvFile In this mode, a csv file is used to initialize
fields.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1163
Data Types

CombineCsvRestartFiles In this mode, a csv file is used to initialize

fields and a restart file is used to initialize time
scheme (starting time + derivates).
ManyResultFiles In this mode, a list of polyflow result files will
be used to define the flow field on which we
evaluate a transient mixing task (computation
of a set of trajectories).
ManyCsvFiles In this mode, a list of polyflow csv files will be
selected for a conversion into other kinds of
results .. for a future mixing task for example.
InitializationFromCsvFiles In this mode, csv files are used to initialize
fields. The CSV file(s) will be selected in Poly-
data.

SourceInformation
Information about the original source of the Engineering Data.

SourceSelectionType
Options for source selection types

Possible Values
BrowseSource
ActiveCADAttach

SpanwiseDistributionType
Spanwise distribution type

Possible Values
General Blade exported using general spanwise distri-
bution
Radial Blade exported using radial spanwise distribu-
tion

SpeedInputType
Speedline input methods

Possible Values
Range Set range using min and max values
Direct Specify mass flow rates directly

StackingType
stacking type

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1164 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
Radial Radial stacking
Tan Beta calculated from tangent
Sin Beta calculated from sin

Status
The current calculation status of the Excel file.

Possible Values
UpToDate The output parameters are up to date.
OutOfDate The values of the input parameters are modi-
fied and the values of the output parameters
are not recalculated yet.
ErrorsWhenCalculating Errors ocurred during the calculation in Excel.

StepSizeType
The method used to determine the size of integration steps in streamline creation.

Possible Values
Automatic
Fixed

STLSDTAlgorithm
SDT Algorithm Options

Possible Values
STLSDTAlgorithm_Curvatures Curvature based SDT algorithm
STLSDTAlgorithm_Angles Angle based SDT algorithm

StraightSidedElements
Used to force mesher to create elements with straight edges. The default value is No.

Possible Values
Yes
No

StreamlineColorOption
Allowable values for how a streamline is colored.

Possible Values
None

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1165
Data Types

Time

StreamLineDisplayStyle
Allowable values for how a streamline is displayed.

Possible Values
Lines
LinesAndSymbols
Symbols

StreamLineShapeDef
Allowable values for the shape of the streamline

Possible Values
Wire
Ribbon
Tube

StreamLineStyle
Allowable values for the style of the streamline

Possible Values
Continuous
Segments

string
This type represents a String value.

SymbolLengthOptions
The allowable values for the control of vector length display.

Possible Values
BasedOnMagnitude
Constant

SymbolShape
The symbol shape used for the associated result

Possible Values
SymbolShape1DArrowHead
SymbolShape1DArrow
SymbolShape2DArrowHead

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1166 of ANSYS, Inc. and its subsidiaries and affiliates.
 SymbolShape2DArrow
SymbolShape3DArrowHead
SymbolShape3DArrow
SymbolShape3DCrossHair
SymbolShape3DCube
SymbolShape3DSphere

SymmetryBehavior
A flag to notify the program if symmetry contact behavior should be used in the physics solution.

Possible Values
Yes
No

SystemPropertyDictionary
A dictionary holding system properties. The keys in the dictionary will be of the standard names defined
in Ansys.ProjectSchematic.SystemPropertyNames. For each property, the value in the dictionary is a list
of all unique values of that property.

TableInterpolation
An enum of the type of interpolation to use when accessing data from the table at a given index. The
valid enum values are; None, Linear, Cubic Spline.

Possible Values
None No interpolation is done.
Linear A linear interpolation will be used to compute
the return value.

TableInterpolationBeyondBounds
An enum which describes what will occur when the index is outside of the bounds of the table. The
valid enum values are; Constant, Fit, Zero, and Error.

Possible Values
Constant his option will cause the value returned to be
the data at the index nearest to the requested
index.
Fit This option will ignore the bounds of the table
and use the Interpolation algorithm to fit the
data and then compute the value at the re-
quested index.
Zero This option will cause the value returned to
be zero if the index is outside of the bounds
of the table.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1167
Data Types

Error If the data cannot be determined from the

given index (outside of the bounds) then an
error will occur.

TessellationRefinement
Used to specify value to be used for tessellation refinement. The default value is AutomaticallyDetermined.

Possible Values
AutomaticallyDetermined Sets tessellation refinement to 10% of the
value of Min Size/Proximity Min Size.
UserDefined Sets tessellation refinement to user defined
value.
Off Tessellation refinement is not performed.

TipDiamType
Impeller tip diameter option

Possible Values
Automatic D2 calculated automatically (from stability
factor)
HeadCoeff D2 calculated from head coefficient
User D2 user defined

TopologyType
All of the possible values for topology.

Possible Values
Point A topological point
Curve A topological curve
Surface A topological surface
Volume A topological volume

TradeoffChartModes
Enumeration of the available Tradeoff chart modes.

Possible Values
Curve2D 2D tradeoff chart where a parameter is plotted
versus another parameter.
Surface3D 3D tradeoff chart where a parameter is plotted
versus two other parameters.

TranscriptType
The allowable types of output in a Transcript monitor.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1168 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
SolverOutput
PhysicsCouplingDiagnostic
SelectFile

TransferAtType
Enum providing options of when to Transfer Data.

Possible Values
StartOfStep Transfer data at start of step.
StartOfIteration Transfer data at start of iteration.

TransferDataFromNewComponentSpec
Specifies the information needed to transfer data from a component that is being created in a new
system.

TransferDataToNewComponentSpec
Specifies the information needed to transfer data to a component that is being created in a new system.

Transform4x4
Represents a combined rotation and translation matrix Rotation matrix is the first 3 rows and columns
in row-major order Translation matrix is the 4th column

TransformationType
Enumeration of the available transformation types applicable to an output parameter.

Possible Values
TransTypeNone No transformation
TransTypeBox Box-Cox
TransTypeYeo Yeo-Johnson

TriangleSurfaceMesher
Used to specify the surface meshing algorithm to be used by patch conforming mesher. The default
value is ProgramControlled.

Possible Values
ProgramControlled Mesher determines usage of Delaunay or Ad-
vancing Front algorithm.
AdvancingFront Mesher uses Advancing Front algorithm but
can switch to Delaunay if problems occur.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1169
Data Types

TrimType
Trim Type to control trimming such as keeping it on, off, or program-controlled.

Possible Values
ProgramControlled
On
Off

TripletType
An enumeration to describe the type of Triptlet that is used in Coordinate systems, Reference frames,
and Vector objects.

Possible Values
Cartesian
Cylindrical
Spherical

TypeOfInitialSampling
Enumeration for the Initial Sampling Type.

Possible Values
E_Screening Screening
E_OSF Optimal Space-Filling
E_ConstrainedSampling Constrained Sampling

uint
This type represents an unsigned integer number. Negative values are invalid.

UniversalVectorDefineBy
Options for defining the vector

Possible Values
Components
MagnitudeAndDirection

UpdatableEntityState
Types of state an updatable entity can have.

Possible Values
Unknown entity state can not be defined.
OutOfDate entity is out of date.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1170 of ANSYS, Inc. and its subsidiaries and affiliates.
 UpToDate entity is up to date.
Error last update of the entity gave an error.
OutOfDateWithError entity is out of date and last update of the
entity gave an error.
UpToDateWithError entity is up of date and last update of the
entity gave an error.
RefreshRequired entity needs a refresh.

UpdateErrorBehavior
Specifies the types of behavior if an error is encountered when updating multiple design points.

Possible Values
Stop Terminate the update immediately on the first
error.
SkipDesignPoint Don't do any more work on the failing design
point, but continue with the next one if any.
Continue Update as much of the project, and as many
design points, as possible.

UseAdvancedSizeFunction
Used to specify which advanced size function option should be used by the mesher.

Possible Values
Adaptive
ProximityCurvature
Curvature
Proximity
Fixed

UseAllProcessors
Used to specify the usage of all available processors for parallel part-based meshing. The default value
is Yes.

Possible Values
Yes Automatically detects and utilizes all available
processors for meshing parts of an assembly
in parallel.
No Manually specify the limit to the number of
processors that can be utilized for parallel
part-based meshing.

UsePostSmoothing
Used to specify whether post inflation smoothing will be performed. The default value is Yes.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1171
Data Types

Possible Values
Yes
No

ValueDefineBy
This property determines whether the value on the object should be program controlled, a physical
value, a factor value, or an auto detection value.

Possible Values
Unknown
kProgramControlled
kPhysicalValue
kFactor
kAutoDetectValue

VariableConversionOption
Enumeration to specify the conversion of data

Possible Values
NoConversion
AverageSharedNodes
AverageNodesToElement
AverageNodesToFace
DistributeElementToNodesEqually
DistributeFaceToNodesEqually
AverageCornerToMidsideNodes

VariableExposure
Level of exposure for variables in the CDI

Possible Values
Standard Default
Expert Expert

VariableStyle
Styles that can be used to display the variable. Default is Line

Possible Values
None
Line
Spline
Step
Bar

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1172 of ANSYS, Inc. and its subsidiaries and affiliates.
 Default

Vector3D
Represents a three dimensional vector using double precision.

VectorCalculationMethod
Options for calculating a vector from geometry selection

Possible Values
Automatic
HitPointNormal
WeightedAverageNormal
HitPointTangent
NearestVertexTangent
WeightedAverageTangent
CenterAxis
TwoVertices

VectorDefineBy
This property sets the type of vector specification which could be by Components or MagnitudeAndDir-
ection or NormalToSurface.

Possible Values
Components
MagnitudeAndDirection
NormalToSurface

VectorType
Motion vector types used in mechanics.

Possible Values
Unknown
Displacement
Velocity
Acceleration
Rotation
AngularVelocity
AngularAcceleration

ViscosityType
viscosity type

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1173
Data Types

Possible Values
Sutherland Viscosity calculated using Sutherland's Law (2
coefficient method)
Dynamic User-specified dynamic viscosity
Kinematic User specified kinematic viscosity

VoluteType
Volute style option

Possible Values
Elliptic Elliptic/circular cross sections
Rectangular Rectangular cross sections

WeightingType
Available expression weight types

Possible Values
Simple
Length
Area
Volume
Mass

WrapMethod
Used to specify the wrapping method to be used for the meshing region. The default value is ShrinkWrap.

Possible Values
ShrinkWrap
CutWrap

XAxisQuantity
Enum for quantity used for X-axis.

Possible Values
Iteration
FlowTime
TimeStep

YesOrNo
This property decides whether the property should be active or not.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1174 of ANSYS, Inc. and its subsidiaries and affiliates.
Possible Values
kYes
kNo

YN
This is enum for yes/no option

Possible Values
ICYes
ICNo

Zoning
Used to specify the option to be used for zoning. The default value is Body.

Possible Values
Part Creates a single zone for each part.
Body Creates a separate zone for each body.
Face Creates a separate zone for each face.

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1175
 Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1176 of ANSYS, Inc. and its subsidiaries and affiliates.
 scripting definition, 9
Index Data Containers
ACP Setup, 49
A Ansoft, 51
ACP Setup data container, 49 Ansoft Feedback Iterator, 53
Ansoft data container, 51 AQWA Model, 57
Ansoft Feedback Iterator data container, 53 AQWA Results, 59
Ansoft Namespace, 1047 AQWA Setup, 60
ANSYS Workbench journaling AQWA Solution, 62
overview, 1 AUTODYN Analysis, 65
ANSYS Workbench scripting AUTODYN Setup, 65
examples, 18 CFD Results, 69
APDL example, 28 CFX Setup, 73
data-integrated application, 28 CFX Solution, 76
embedded script, 28 DX Direct Optimization, 83
file management, 22 DX Evaluation Container, 128
material properties, 25 DX GDO Design of Experiment, 197
project updates, 18 DX GDO Response Surface, 220
tabular data, 25 DX Parameters Correlation, 254
updating from Excel, 31 DX Six Sigma Analysis, 271
file path handling, 17 Engineering Data, 289
object-based, 15 Engineering Data Curve Fit, 323
overview, 1 Engineering Data Favorite Items, 327
path handling, 17 Engineering Data Favorite Library, 348
units, 16 External Connection, 375
using, 15 External Data, 377
APDL script scripting examples, 28 External Model Setup, 391
AQWA Model data container, 57 Finite Element Modeler, 399
AQWA Results data container, 59 FLUENT Setup, 409
AQWA Setup data container, 60 FLUENT Solution, 422
AQWA Solution data container, 62 FLUENT TGridData, 437
argument Geometry, 441
scripting definition, 11 Graphics, 451
AUTODYN Analysis data container, 65 ICE, 469
AUTODYN Setup data container, 65 ICE Setup, 471
ICEM CFD, 475
IcePak Setup, 477
C IcePak Solution, 478
CFD Results data container, 69
Mechanical APDL, 481
CFX Setup data container, 73
Mechanical Enhanced Model, 487
CFX Solution data container, 76
Mechanical Model, 488
command window
Mechanical Results, 497
journaling, 2
Mechanical Setup, 502
navigation, 3
Mechanical Solution, 505
component
Mesh, 511
scripting definition, 8
Microsoft Office Excel Analysis, 519
console window
Parameters, 527
journaling, 6
Polyflow Setup, 537
Polyflow Solution, 541
D Project, 545
data container Project File Types, 557
scripting definition, 8, 15 Project Files, 558
data container reference

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1177
Index

Project Messages, 563 Fluent Namespace, 1059

Study, 565 FLUENT Setup data container, 409
System Coupling Setup, 855 FLUENT Solution data container, 422
System Coupling Solution, 873 FLUENT TGridData data container, 437
Turbo Geometry, 883
Turbo Mesh, 888 G
Turbo Setup, 893 Geometry data container, 441
Units, 1043 Graphics data container, 451
Vista AFD Analysis, 922 Graphics Namespace, 1059
Vista AFD Design, 938
Vista AFD Meanline, 955 I
Vista CCD, 963 ICE data container, 469
Vista CCM, 991 ICE Setup data container, 471
Vista CPD, 998 ICEM CFD data container, 475
Vista RTD, 1016 IcePak Setup data container, 477
Vista TF Setup, 1034 IcePak Solution data container, 478
Vista TF Solution, 1041 IronPython, 5
data entity
scripting definition, 9, 15 J
data reference
journaling
scripting definition, 9
command window, 2
Data Types, 1111
navigation, 3
data-integrated applications
shortcuts, 3
scripting, 6
console window, 6
data-integrated applications scripting examples, 28
definition, 1, 7
DX Direct Optimization data container, 83
overview, 1
DX Evaluation Container data container, 128
playing a journal, 2
DX GDO Design of Experiment data container, 197
preferences, 2
DX GDO Response Surface data container, 220
recording, 2
DX Parameters Correlation data container, 254
uses, 1
DX Six Sigma Analysis data container, 271
K
E keyboard shortcuts
EKM Namespace, 1050
command window, 3
embedded script scripting examples, 28
Known Issues and Limitations, 45
EngData Namespace, 1056
Engineering Data Curve Fit data container, 323
Engineering Data data container, 289
M
material properties scripting examples, 25
Engineering Data Favorite Items data container, 327
Mechanical APDL data container, 481
Engineering Data Favorite Library data container, 348
Mechanical Enhanced Model data container, 487
Extensions Namespace, 1057
Mechanical Model data container, 488
External Connection data container, 375
Mechanical Namespace, 1062
External Data data container, 377
Mechanical Results data container, 497
External Model Setup data container, 391
Mechanical Setup data container, 502
Mechanical Solution data container, 505
F Mesh data container, 511
file management scripting examples, 22
Meshing Namespace, 1063
file path handling
method
ANSYS Workbench scripting, 17
scripting definition, 11
absolute/relative paths, 17
Microsoft Office Excel Analysis data container, 519
slashes, 17
Finite Element Modeler data container, 399

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
1178 of ANSYS, Inc. and its subsidiaries and affiliates.
N S
namespaced command scripting
scripting definition, 12 definition, 5
Namespaced Commands, 1047 argument, 11
Namespaces component, 8
Ansoft, 1047 data container, 8
EKM, 1050 data container reference, 9
EngData, 1056 data entity, 9
Extensions, 1057 method, 11
Fluent, 1059 namespaced command, 12
Graphics, 1059 object, 11
Mechanical, 1062 project, 8
Meshing, 1063 property, 11
Parameters, 1063 query, 12
Project, 1071 system, 8
Study, 1107 templates, 12
definitions, 7
O data container, 15
object data entity, 15
scripting definition, 11 data reference, 9
overview, 1
P SendCommands, 6
Parameters data container, 527 using, 15
Parameters Namespace, 1063 with data-integrated applications, 6
path handling SendCommands
ANSYS Workbench scripting, 17 using, 6
absolute/relative paths, 17 setting journaling preferences, 2
slashes, 17 setting preferences
Playing a journal, 2 journaling, 2
Polyflow Setup data container, 537 shortcuts
Polyflow Solution data container, 541 command window, 3
preferences Study data container, 565
journaling, 2 Study Namespace, 1107
project system
scripting definition, 8 scripting definition, 8
Project data container, 545 System Coupling Setup data container, 855
Project File Types data container, 557 System Coupling Solution data container, 873
Project Files data container, 558
Project Messages data container, 563 T
Project Namespace, 1071 tabular data scripting examples, 25
Project updates scripting examples, 18 templates
property scripting definition, 12
scripting definition, 11 Turbo Geometry data container, 883
Python, 5 Turbo Mesh data container, 888
Turbo Setup data container, 893
Q
query U
scripting definition, 12 units
ANSYS Workbench scripting, 16
R Units data container, 1043
recording a journal, 2 updating from Excel scripting examples, 31
using ANSYS Workbench scripting, 15

Release 16.0 - © SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1179
Index

using the command window

journaling, 2
navigation, 3

V
Vista AFD Analysis data container, 922
Vista AFD Design data container, 938
Vista AFD Meanline data container, 955
Vista CCD data container, 963
Vista CCM data container, 991
Vista CPD data container, 998
Vista RTD data container, 1016
Vista TF Setup data container, 1034
Vista TF Solution data container, 1041

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