0% found this document useful (0 votes)

2K views

Workbench Scripting Guide 15

guia workbench scripting

Uploaded by

Ovidio Rodríguez

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

2K views

Workbench Scripting Guide 15

guia workbench scripting

Uploaded by

Ovidio Rodríguez

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 802

Workbench Scripting Guide

ANSYS, Inc.
Southpointe
275 Technology Drive
Canonsburg, PA 15317
[email protected]
http://www.ansys.com
(T) 724-746-3304
(F) 724-514-9494

Release 15.0
November 2013
ANSYS, Inc. is
certified to ISO
9001:2008.

Copyright and Trademark Information

2013 SAS IP, Inc. All rights reserved. Unauthorized use, distribution or duplication is prohibited.
ANSYS, ANSYS Workbench, Ansoft, AUTODYN, EKM, Engineering Knowledge Manager, CFX, FLUENT, HFSS and any
and all ANSYS, Inc. brand, product, service and feature names, logos and slogans are registered trademarks or
trademarks of ANSYS, Inc. or its subsidiaries in the United States or other countries. ICEM CFD is a trademark used
by ANSYS, Inc. under license. CFX is a trademark of Sony Corporation in Japan. All other brand, product, service
and feature names or trademarks are the property of their respective owners.

Disclaimer Notice
THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFIDENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products
and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement
that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products
and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions
of that software license agreement.
ANSYS, Inc. is certified to ISO 9001:2008.

U.S. Government Rights

For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use,
duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc.
software license agreement and FAR 12.212 (for non-DOD licenses).

Third-Party Software
See the legal information in the product help files for the complete Legal Notice for ANSYS proprietary software
and third-party software. If you are unable to access the Legal Notice, please contact ANSYS, Inc.
Published in the U.S.A.

Table of Contents
Scripting Overview ..................................................................................................................................... 1
Journaling and Scripting Capability Overview ......................................................................................... 1
Journaling ........................................................................................................................................ 1
Recording and Playing a Journal ................................................................................................. 2
Using the Command Window ..................................................................................................... 3
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 ...................................................................................................... 13
Object-Based Approach ........................................................................................................................ 13
File Path Handling in ANSYS Workbench ................................................................................................ 14
Units .................................................................................................................................................... 15
Usage Examples ................................................................................................................................... 16
Automatically Update all Projects Affected by a Design Modification ............................................... 16
Interaction with Files in a Project ..................................................................................................... 20
Material Properties and Tabular Data ............................................................................................... 23
Mechanical APDL and Sending Commands to Integrated Applications ............................................. 25
Updating a Workbench Project and Parameters from Excel .............................................................. 29
Known Issues and Limitations .................................................................................................................. 33
Known Issues and Limitations ............................................................................................................... 33
I. Data Containers ..................................................................................................................................... 35
Ansoft ................................................................................................................................................. 37
Ansoft ............................................................................................................................................ 37
Ansoft Feedback Iterator .................................................................................................................... 39
Ansoft Feedback Iterator ................................................................................................................. 39
AQWA .................................................................................................................................................. 43
AQWA Model .................................................................................................................................. 43
AQWA Results ................................................................................................................................. 45
AQWA Setup ................................................................................................................................... 46
AQWA Solution ............................................................................................................................... 48
AUTODYN ............................................................................................................................................ 51
AUTODYN Analysis .......................................................................................................................... 51
AUTODYN Setup ............................................................................................................................. 51
CFD Results ......................................................................................................................................... 55
CFD Results .................................................................................................................................... 55
CFX ...................................................................................................................................................... 59
CFX Setup ...................................................................................................................................... 59
CFX Solution ................................................................................................................................... 62
Design Exploration ............................................................................................................................. 67
DX Direct Optimization ................................................................................................................... 67
DX Evaluation Container ............................................................................................................... 110
DX GDO Design of Experiment ...................................................................................................... 179
DX GDO Response Surface ............................................................................................................ 200
DX Parameters Correlation ............................................................................................................ 232
DX Six Sigma Analysis ................................................................................................................... 249
Engineering Data .............................................................................................................................. 265
Engineering Data .......................................................................................................................... 265
Engineering Data Curve Fit ........................................................................................................... 299
Engineering Data Favorite Items .................................................................................................... 303
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

iii

Scripting Guide
Engineering Data Favorite Library ................................................................................................. 324
External Connection ......................................................................................................................... 351
External Connection ..................................................................................................................... 351
External Data .................................................................................................................................... 353
External Data ................................................................................................................................ 353
External Model Setup ....................................................................................................................... 367
External Model Setup .................................................................................................................... 367
Finite Element Modeler .................................................................................................................... 375
Finite Element Modeler ................................................................................................................. 375
FLUENT .............................................................................................................................................. 385
FLUENT Setup ............................................................................................................................... 385
FLUENT Solution ........................................................................................................................... 398
Geometry .......................................................................................................................................... 415
Geometry ..................................................................................................................................... 415
Graphics ............................................................................................................................................ 425
Graphics ....................................................................................................................................... 425
ICE ..................................................................................................................................................... 443
ICE ............................................................................................................................................... 443
ICE Setup ...................................................................................................................................... 445
ICEM .................................................................................................................................................. 449
ICEM CFD ..................................................................................................................................... 449
IcePak ................................................................................................................................................ 451
IcePak Setup ................................................................................................................................. 451
IcePak Solution ............................................................................................................................. 452
Mechanical APDL .............................................................................................................................. 455
Mechanical APDL .......................................................................................................................... 455
Mechanical ........................................................................................................................................ 461
Mechanical Enhanced Model ........................................................................................................ 461
Mechanical Model ........................................................................................................................ 462
Mechanical Results ....................................................................................................................... 471
Mechanical Setup ......................................................................................................................... 472
Mechanical Solution ..................................................................................................................... 475
Mesh .................................................................................................................................................. 481
Mesh ............................................................................................................................................ 481
Microsoft Office Excel Analysis ......................................................................................................... 489
Microsoft Office Excel Analysis ...................................................................................................... 489
Parameters ........................................................................................................................................ 497
Parameters ................................................................................................................................... 497
Polyflow ............................................................................................................................................ 507
Polyflow Setup ............................................................................................................................. 507
Polyflow Solution .......................................................................................................................... 511
Project ............................................................................................................................................... 515
Project .......................................................................................................................................... 515
Project File Types .......................................................................................................................... 526
Project Files .................................................................................................................................. 527
Project Messages .......................................................................................................................... 532
System Coupling ............................................................................................................................... 535
System Coupling Setup ................................................................................................................. 535
System Coupling Solution ............................................................................................................. 553
TurboSystems ................................................................................................................................... 563
Turbo Geometry ........................................................................................................................... 563
Turbo Mesh .................................................................................................................................. 568

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

Scripting Guide
Vista AFD Analysis ......................................................................................................................... 572
Vista AFD Design .......................................................................................................................... 589
Vista AFD Meanline ....................................................................................................................... 605
Vista CCD ...................................................................................................................................... 614
Vista CCM ..................................................................................................................................... 641
Vista CPD ...................................................................................................................................... 648
Vista RTD ...................................................................................................................................... 666
Vista TF Setup ............................................................................................................................... 684
Vista TF Solution ........................................................................................................................... 692
Units .................................................................................................................................................. 693
Units ............................................................................................................................................ 693
Namespaced Commands .......................................................................................................................... 697
Ansoft ................................................................................................................................................ 697
EKM .................................................................................................................................................... 700
EngData ............................................................................................................................................. 705
Extensions .......................................................................................................................................... 706
Graphics ............................................................................................................................................. 709
Mechanical ......................................................................................................................................... 712
Meshing ............................................................................................................................................. 712
Parameters ......................................................................................................................................... 713
Project ................................................................................................................................................ 720
Data Types ................................................................................................................................................ 753
Data Types .......................................................................................................................................... 753
Index ........................................................................................................................................................ 793

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.

Note
Not all actions are journaled. Only actions that change project data 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)

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. 1)). 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.
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). They can be used with any
ANSYS installation (release 12.1 or higher).
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.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Scripting Overview
1.

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

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

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.

Specify the number of days to keep a journal file.

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

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. 3).
Recording a Journal
1.

Launch ANSYS Workbench.

Select File > Scripting > Record Journal.

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

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

Select File > Scripting >Stop Recording Journal.

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

Playing Back a Recorded Journal

Select File > Scripting > Run Script File.

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

Journaling and Scripting Capability Overview

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

The previously recorded actions will be performed again.

Note
Because variables may be changed or overwritten, the results may be different on repeated
runs as they will be acting on the outcome of the previous runs.

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.
1.

Select File > Scripting > Open Command Window.

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

As you enter each command, the appropriate action will occur in the ANSYS Workbench 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 ImportJournalVariables() in the command window to make the variable definitions from the currentlyrecorded 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. 1)). 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 ImportJournalVariables() 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.

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

Scripting Overview

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 interaction.
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

Ctrl + Right Arrow

Moves the cursor forward one word

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
Down

Recalls the next command in the history list

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.
4

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

Journaling and Scripting Capability Overview

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.

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. 13).
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 compatibility with the Python language. For more information on IronPython, see http://ironpython.codeplex.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.ansys.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>/v150/Framework/bin/<platform>/runwb2

<platform> will be one of the following:

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\V150\Framework\bin\win64\runwb2

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

Scripting Overview
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.

-R <ANSYS
Workbench
script
file>

Replay the specified ANSYS Workbench script file on start-up. If specified in conjunction
with B, ANSYS Workbench will start in batch mode, execute the specified script, and
shut down at the completion of script execution.

-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
Workbench
project
file>

Load the specified ANSYS Workbench project file on start-up.

-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 application.
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 dataintegrated 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, Mechanical APDL is based on the powerful ANSYS Parametric Design Language (APDL), and APDL commands
6

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

ANSYS Workbench Project and Data Model Concepts

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 applications; however, data-integrated applications do not necessarily record operations in the ANSYS Workbench 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 DataIntegrated 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. 25) 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 Applications

Native Scripting Language

Supports Scripting
with SendCommand

Mechanical APDL

APDL

Yes

Mechanical

JScript

Yes

CFX

CCL

Yes

Fluent

Scheme

Yes

Aqwa

JScript

Yes

Autodyn

Not Available

CFD-Post

CCL

Yes

FE Modeler

JScript

Yes

DesignModeler

JScript

Yes

Meshing

JScript

Yes

Polyflow

Not Available

IcePak

Not Available

ICEM CFD

TCL

Yes

Supports Journaling with SendCommand

Yes

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

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
assembly.
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 components local data are provided by the data container, while services to control the transfer of data into and out of the component are provide by
the component.

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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
references 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.

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 objects 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 objects 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
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Scripting Overview
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 objects methods are accessed by applying the dot operator on
a corresponding data reference. In the following example, parameter1 is a data reference to a Parameter object, and the method SetQuantityUnits is called to set the objects units to meters.
parameter1.SetQuantityUnits("m")

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 arguments are Variables and Values which are set to Density and 8500 [kg m^-3]}, respectively.
property1.SetData(Variables="Density", Values="8500 [kg m^-3]")

Because ANSYS Workbench uses named arguments, the following form of the command is also acceptable.
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()

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.
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.

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

ANSYS Workbench Project and Data Model Concepts

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 particular 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
performed 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).

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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
interrogate 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 Manufacturable 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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Using Scripting in ANSYS Workbench

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

Typical usage examples are provided below. 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.

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
converted 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 different locations on a file system, a User Path Root is used to dynamically record and construct the absolute 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 absolute path based on the supplied relative path and the current User Path Root.
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:

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

Units
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

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 inconvenient 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 Material 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:
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Using Scripting in ANSYS Workbench

material1= eda1.GetMaterial(Name=Structural Steel)
materialProperty1= material1.GetProperty(Name=Density)
materialProperty1.SetData(
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])

Usage Examples
Several examples are provided here to demonstrate some typical scripting uses:
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

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.
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:
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 analysis of a blood mixing device. This device attempts to maximize mixing of two blood streams while

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

Usage Examples
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
2
3
4
5
6

# import the 'os' module, which provides a portable way of using operating system-dependent functionality
import os

# Helper function to write parameters to the log file

def writeParams(logFile):
for param in Parameters.GetAllParameters():
prmString = " " + param.Name + ": " + param.DisplayText + " = " +
7 param.Value.ToString()
8
logFile.write(prmString + "\n")
9
logFile.flush()
10
11 # Define the original and target directories
12 origDir = AbsUserPathName("Demo/ScriptExample1/Original")
13 newDir = AbsUserPathName("Demo/ScriptExample1/Modified")
14
15 # Define new geometry file
16 newGeom = AbsUserPathName("Demo/ScriptExample1/Geometry/bloodMix2.agdb")
17
18 # Open a log file to record script progress
logFile =
19 open(AbsUserPathName("Demo/ScriptExample1/GeometryReplace.log"),"w")
20
21 # Create the new directory if necessary
22 if not os.path.exists(newDir):
23
os.makedirs(newDir)
24
25 # Find all the projects in the original directory
26 projList = []
27 for fileName in os.listdir(origDir):

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

Using Scripting in ANSYS Workbench

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

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]
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]

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

Usage Examples
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-16
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. 14) for further details.
Lines 18-19
Standard Python functionality is used to open and write output to a log file throughout this script.
Lines 21-29
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.
Lines 31-38
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 Pythons 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.

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

Using Scripting in ANSYS Workbench

Lines 40-42
The writeParams function defined earlier in the script is used to record parameter values to the log
file before project modification.
Lines 44-45
The GetAllSystems() query is used to provide references to all systems in the project.
Lines 46-51
Since we are specifically interested in Geometry components, we use the systems 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 53-54
An ANSYS Workbench project update is used to recompute all aspects of the project affected by the
geometry change. This step is the most computationally expensive part of the script.
Lines 56-65
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
parameter information to the log file. If the update was not successful, we record any project messages
that were generated during the update.
Lines 62-65
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 67-69
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.
To automate this search, we will write a script that performs the operations described below. Two different 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
registered to it. Then look if the component is using a file of the specified name. This method is a

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

Usage Examples
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 recursively 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 = GetUserPathRoot()
20
21 # Define file name of interest
22 targetFile = "pipe.x_t"
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("FindFileInProjects.log"),"w")
30
31 for projFile in projList:
32
try:
33
Open(FilePath=projFile)
34
except:
35
logFile.write("Error opening %s\n" % projFile)
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
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))

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

Using Scripting in ANSYS Workbench

64
65
66
67 logFile.close()

Log File

logFile.write(fileStr % (compFile.Location, compFile.Size, compFile.LastModifiedTime))

logFile.flush()

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. Discussion 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.
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.

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

Usage Examples

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.
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/Youngs 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

Workbench Script The script for this example follows. Each line is numbered for reference in the
discussion that follows.
1 # Create a Static Structural system and access its data container for Engineering Data
2 template1 = GetTemplate(
3
TemplateName="Static Structural",
4
Solver="ANSYS")
5 system1 = template1.CreateSystem()
6 engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
7
8 # Import Polyethylene
9 poly = engineeringData1.ImportMaterial(
10
Name="Polyethylene",
11
Source="General_Materials.xml")
12
13 # Initialize lists for variable values
14 temperature = []
15 strain = []
16 stress = []
17
18 # Get the value of Young's Modulus for use in the Total/Plastic strain calculation.
19 # Material Property data is always returned as a Quantity.
20 elasticity = poly.GetProperty(Name="Elasticity")
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Using Scripting in ANSYS Workbench

21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

E = elasticity.GetData(Variables="Young's Modulus")
# Read the data file and create lists for Temperature, Strain and Stress values
# We must convert Total Strain in the data file into Plastic Strain
fileName = AbsUserPathName("Demo/ScriptExample3/StressStrainData.txt")
dataFile = open(fileName,"r")
for line in dataFile:
# Skip comment lines
if line.startswith("#"):
continue
# Split at the comma to get strain, stress
(thisStrain, thisStress) = line.split(",")
# Convert the data into Quantities with units that are consistent with the data file.
thisStrain = Quantity(float(thisStrain),"m m^-1")
thisStress = Quantity(float(thisStress),"MPa")
# Append data to the variable lists (converting total strain to plastic strain)
temperature.append(0)
strain.append(thisStrain - thisStress/E)
stress.append(thisStress)
# Create the Multilinear Isotropic Hardening property and set the data for it
miso = poly.CreateProperty(
Name="Isotropic Hardening",
Definition="Multilinear")
miso.SetData(
SheetName="Isotropic Hardening",
SheetQualifiers={"Definition Method": "Multilinear"},
Variables = ["Temperature","Plastic Strain","Stress"],
Values = [temperature, strain, stress])
# Save the project
Save(
FilePath=AbsUserPathName("Demo/ScriptExample3/ex3.wbpj"),
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
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-11
To set the project up to work with Polyethylene, we create a new Static Structural system, access its
Engineering Data container, and load material data from the General Materials library.
Lines 13-16
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
temperature, strain and stress data. Multilinear Isotropic Hardening property data can be temperaturedependent, and temperature is a required variable in the data table. Since our data is not temperaturedependent, we will use the same value of temperature (0 [C]) at each strain/stress point.
Lines 18-21
Since the calculation for plastic strain depends on Youngs Modulus, we use the GetData() method
to get the Youngs 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 23-30
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.

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

Usage Examples
Lines 32-33
The Python split() function is used to break the comma delimited line and return the separate values
into variables for strain and stress.
Lines 35-37
In this example we are creating explicit unit-based quantities for stress and strain values, to ensure dimensional 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 writers responsibility to ensure the numeric data and project units are consistent).
Line 40
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
temperature data for this strain/stress pair.
Line 41
Here we calculate plastic strain based on the available quantities and append it to the variable list.
Mathematical operations involving quantities enforce dimensional consistency and automatically perform
unit conversion as necessary to generate a consistent result.
Line 42
Stress data is also appended to the appropriate list.
Lines 45-47
A new property for Multilinear Isotropic Hardening is created within Polyethylene.
Lines 48-52
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 54-57
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.
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 described below:
1. Create a system for Mechanical APDL analysis, and loads the specified ANSYS input file.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Using Scripting in ANSYS Workbench

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
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 # Specify the Mechanical APDL Input file to be processed
6 inputFile = AbsUserPathName("Demo/ScriptExample4/bar.dat")
7
8 # Provide a list of bar length (Z) values to solve and write CDB files for.
9 # Note: We expect '0' to fail.
10 zValues = [3,5,0,12,15]
11
12 # Open a log file to record script progress

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

Usage Examples
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

logFile = open(AbsUserPathName("my_bar_script.log"),"w")
# Start a new project and create the Mechanical APDL system
Reset()
template1 = GetTemplate(TemplateName="Mechanical APDL")
system1 = template1.CreateSystem()
# Read the input file into the Mechanical APDL Setup
setup1 = system1.GetContainer(ComponentName="Setup")
mapdlInputFile1 = setup1.AddInputFile(FilePath=inputFile)
# Create Workbench parameters from two of the Mechanical APDL parameters
# in the input file
mapdlInputFile1.PublishMapdlParameter(Name="ZLEN")
parameter1 = Parameters.GetParameter(Name="P1")
mapdlInputFile1.PublishMapdlParameter(
Name="OUT_UY",
IsDirectOutput=True)
parameter2 = Parameters.GetParameter(Name="P2")
# Save the initial project definition.
Save(
FilePath=AbsUserPathName("Demo/ScriptExample4/myBar.wbpj"),
Overwrite=True)
# Loop through all provided bar lengths
for zVal in zValues:
# Set the Z (length) parameter expression
parameter1.Expression = str(zVal)
logFile.write("Updating for z = %s\n" % zVal)
# Update the project
# success or failure
try:
Update()
except:
logFile.write("
else:
logFile.write("

for the new parameter value, and report

to the log file.

Update failed.\n")
Update succeeded. UY = %s\n" % parameter2.Value)

# Generate the name of the CDB file to save

cdbName = os.path.join(GetUserFilesDirectory(), "my_bar_" + str(zVal) + ".cdb")
cdbNameForCmd = cdbName.replace("\\","/")
# Delete the cdb file if it already exists, to prevent
# Mechanical APDL from promting us about overwrite.
if os.path.exists(cdbName):
os.remove(cdbName)
# Generate the APDL command to save the CDB file and send it.
apdlCmd = "cdwr,db,%s" % cdbNameForCmd
setup1.SendCommand(Command=apdlCmd)
logFile.write(" CDB written to %s\n" % cdbName)
# Save the final project state.
Save()
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
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Using Scripting in ANSYS Workbench

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-13
The initial lines of the script import useful modules, define controlling variables and create a log file to
record script progress.
Lines 15-18
Here we start a new project and create a new Mechanical APDL system.
Lines 20-22
We use the AddInputFile method on the Mechanical APDL Setup container to read and process the
specified input file.
Lines 24-33
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
parameter as an input to set the bar length, and the OUT_UY parameter as an output to track maximum
Y displacement.
Lines 34-37
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 39-44
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 46-53
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 55-57
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 59-62
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.
28

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

Usage Examples
Lines 64-67
We generate an APDL command string to write the .cdb file to the desired file path and use the
SendCommand method to execute it. While this example just passes a single line command, the command
string can contain multiple commands separated by newlines.
Lines 69-71
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.
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 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.
You will need additional files to complete this example. These files are located in <os drive>\Program Files\Ansys Inc\V150\commonfiles\examples\Scripting (Windows) or /ansys_inc/v150/commonfiles/examples/Scripting (Linux). You should copy these files to
your working directory.
ParameterExample.xlsx
ExcelParameterScripting.zip -- extract to your working directory.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Using Scripting in ANSYS Workbench

string

Read Only

Yes

string

Read Only

MaxSolveIterations
The Max number of solve iterations allowed when the FBIter is working with a system that sends convergence information
Type

int

Read Only

TargetDeltaDPercentage
The relative tolerance value that indicates convergence for displacement
Type

double

Read Only

TargetDeltaTPercentage
The relative tolerance value that indicates convergence for temperature
Type

double

Read Only

TotalSolveIterations
The total number of solve iterations requested by the user.
Type

int

Read Only

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

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

string

Read Only

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
DataReference for the Model data entity.

Return

Type

DataReference

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

The command to execute in the AQWA editor.

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

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

string

Read Only

GeometrySelected
Specifies if this data entity has Geometry data available.
Type

bool

Read Only

PhysicsType
Entity Physics Type setting.
Type

string

Read Only

Yes

ProjectName
The system string identifier.
Type

string

Read Only

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
DataReference for the Results data entity.

Return

Type

DataReference

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

The command to execute in the AQWA editor.

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

AQWA

Data Entities
AqwaResults
Results data entity.

Properties
AnalysisType
Entity Analysis Type setting.
Type

string

Read Only

Yes

string

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Exit
Exits the AQWA editor.

GetSetup
Get the DataReference for the Setup data entity.
DataReference for the Setup data entity.

Return

Type

DataReference

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

The command to execute in the AQWA editor.

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

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

AQWA
Read Only

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

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Required Arguments
Command

The command to execute in the AQWA editor.

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

string

Read Only

PhysicsType
Entity Physics Type setting.
Type

string

Read Only

Yes

SolverType
Entity Solver Type setting.
Type

string

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

AQWA
Read Only

Yes

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
A reference to the AutodynAnalysis data entity.

Return

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 associated 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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

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

string

Read Only

FileName
The name of the associated input file.
Type

string

Read Only

strUserExecutable
The location of the user defined execuatable to use.

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

Type

string

Read Only

Yes

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

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

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
Command

Valid CFX Command Language (CCL) commands

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

CustomReportTemplate
Specifies the file path of the custom report template to load if LoadReport is set to 'Custom'. It is recommended 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

string

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Type

bool

Read Only

LoadReport
Report to load when Results cell is edited or updated.
Type

PostReportNamesType

Read Only

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

string

Read Only

PostStateFile
CFD-Post State file location.
Do not modify this property directly.
Type

DataReference

Read Only

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

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 ReportLocationDirectory properties.
Type

string

Read Only

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

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

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

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

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

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

Methods
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

string

Read Only

SolverInputExtendedFiles
Extended CFX Solver Input Files for multiconfig cases
Do not modify this property directly.
Type

DataReferenceSet

Read Only

SolverInputFile
CFX-Solver Input file location.
Do not modify this property directly.
Type

DataReference

Read Only

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

CFX

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.
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 SetExecutionControl. 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 ExecutionControlOption 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.

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

string

Read Only

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
UseExecutionControlFromSetup
UseExecutionControlFromSolution
Type

ExecutionControlSource

Read Only

In the case of a conflict, a message is displayed and the process is aborted.

In the case of a conflict, the execution control
provided in the DEF file is used.
In the case of a conflict, the execution control
saved in the Solution container is used.

InitializationOption
Specifies the way a Solution will be initialized during Update.
Available options:
CurrentSolutionData

InitialConditions

Initialize the solution from the current Solution

component data (if the data is present and is
appropriate).
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

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

CFX

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 configurations.
Available options:
AllConfigsSingleCase
AllConfigsSeparateCases

LastConfigOnly

All configurations for this set of results should

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

The default behavior is "LastConfigOnly".

Type

MResOptions

Read Only

ResultsFile
Current CFX-Solver Results File location.
Type

DataReference

Read Only

Yes

SolverArguments
Additional Solver Arguments
Type

string

Read Only

SolverPath
Path to a custom Solver Executable
Type

string

Read Only

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
The DataReference of the Model.

Return

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Design Exploration

CurrentParetoPercentage
Pareto Percentage
Type

double

Read Only

Yes

CurrentStabilityPercentage
Stability Percentage
Type

double

Read Only

Yes

string

Read Only

MaximumNumberOfPermutations
Maximum number of permutations for discrete / manufacturable values.
Type

int

Read Only

Yes

MaxNumCandidates
Maximum Number of Candidates
Type

int

Read Only

MaxNumCycles
Maximum Number Of Cycles for OSFD algorithm.
Type

int

Read Only

MaxNumIterations
Maximum Number of Iterations
Type

int

Read Only

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

MutationProbability
Maximum Allowable Pareto Percentage
Type

double

Read Only

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

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

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

Design Exploration

ParetoPercentage
Maximum Allowable Pareto Percentage
Type

double

Read Only

RandomGeneratorSeed
LHS Seed
Type

int

Read Only

SampleSetSize
Size of Generated Sample Set
Type

int

Read Only

Yes

StabilityCriterion
Maximum Allowable Pareto Percentage
Type

double

Read Only

TypeOfInitialSampling
Type Of Initial Sampling
Type

TypeOfInitialSampling

Read Only

AsoOptimization
Entity which performs and manages the DesignXplorer Optimization Method Component

Properties
Converged
Convergence state
Type

bool

Read Only

Yes

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

ConvergenceTolerance
Convergence Tolerance
Type

double

Read Only

string

Read Only

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

MaxNumCandidates
Maximum Number of Candidates
Type

int

Read Only

MaxNumCycles
Maximum Number Of Cycles for OSFD algorithm.
Type

int

Read Only

MaxNumDomainReductions
Maximum Number of Domain Reductions
Type

int

Read Only

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

Design Exploration

MaxNumEvaluations
Maximum Number of Evaluations
Type

int

Read Only

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

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

int

Read Only

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

int

Read Only

NumCandidates
Number of Candidates
Type

int

Read Only

Yes

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

PercentageOfDomainReductions
Percentage of Domain Reductions
Type

double

Read Only

RandomGeneratorSeed
LHS Seed
Type

int

Read Only

SampleSetSize
Size of Generated Sample Set
Type

int

Read Only

Yes

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

string

Read Only

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

int

Read Only

Value
Value of the DiscreteLevel.
Type

Object

Read Only

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

Design Exploration

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.

Properties
Attribute1
First editable attribute of the distribution for an uncertainty parameter. The nature of the attribute depends on the distribution type. For instance, the first attribute of a Normal distribution is the Mean
value.
Type

double

Read Only

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

ConstantValue
Constant value of the Parameter when it is disabled.
Type

Object

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

Read Only

DiscreteLevels
List of the discrete levels.
Type

List<DataReference>

Read Only

Yes

string

Read Only

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

double

Read Only

DistributionType
Distribution type for an uncertainty parameter.
Type

DistType

Read Only

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

double

Read Only

Enabled
True if the Parameter is enabled for the current study.
Type

bool

Read Only

Kurtosis
Kurtosis value of the distribution for an uncertainty parameter.
Type

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

Design Exploration
Read Only

Yes

LowerBound
Lower bound of the variation range for a Continuous Parameter.
Type

double

Read Only

Mean
Mean value of the distribution for an uncertainty parameter.
Type

double

Read Only

Yes

Nature
Nature of the Parameter.
Type

ParameterNature

Read Only

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.

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

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

Read Only

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

bool

Read Only

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.
The created entity.

Return

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

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

Design Exploration
Index

The position of the new level in the list of discrete levels of the parameter. Index is zerobased. 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")

AddLevels
Adds a list of levels to a continuous input parameter. Each level is a quantity or a real number corresponding 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

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Design Exploration

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)

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.
The DataReference of the discrete level entity.

Return

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")

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

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

Return

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.
The DataReference of the ParameterStatistics entity.

Return

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

Properties
Converged
Convergence state
Type

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

Design Exploration
Read Only

Yes

DerivativeApproximationType
DerivativeApproximationType
Type

DerivativeApproximationType

Read Only

string

Read Only

MaxConvPercentage
Allowable Convergence Percentage
Type

double

Read Only

MaximumNumberOfPermutations
Maximum number of permutations for discrete / manufacturable values.
Type

int

Read Only

Yes

MaxNumCandidates
Maximum Number of Candidates
Type

int

Read Only

MaxNumIterations
Maximum Number of Iterations
Type

int

Read Only

NumberOfEvaluations
Number of Evaluations
Type

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

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

Properties
Converged
Convergence state
Type

bool

Read Only

Yes

CrossoverProbability
Maximum Allowable Pareto Percentage
Type

double

Read Only

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

Design Exploration

CurrentParetoPercentage
Pareto Percentage
Type

double

Read Only

Yes

CurrentStabilityPercentage
Stability Percentage
Type

double

Read Only

Yes

string

Read Only

MaximumNumberOfPermutations
Maximum number of permutations for discrete / manufacturable values.
Type

int

Read Only

Yes

MaxNumCandidates
Maximum Number of Candidates
Type

int

Read Only

MaxNumCycles
Maximum Number Of Cycles for OSFD algorithm.
Type

int

Read Only

MaxNumIterations
Maximum Number of Iterations
Type

int

Read Only

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

MutationProbability
Maximum Allowable Pareto Percentage
Type

double

Read Only

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

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

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

Design Exploration

ParetoPercentage
Maximum Allowable Pareto Percentage
Type

double

Read Only

RandomGeneratorSeed
LHS Seed
Type

int

Read Only

SampleSetSize
Size of Generated Sample Set
Type

int

Read Only

Yes

StabilityCriterion
Stability Criterion
Type

double

Read Only

TypeOfInitialSampling
Type Of Initial Sampling
Type

TypeOfInitialSampling

Read Only

NlpqlOptimization
Entity which performs and manages the DesignXplorer Optimization Method Component

Properties
Converged
Convergence state
Type

bool

Read Only

Yes

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

DerivativeApproximationType
DerivativeApproximationType
Type

DerivativeApproximationType

Read Only

string

Read Only

MaxConvPercentage
Allowable Convergence Percentage
Type

double

Read Only

MaximumNumberOfPermutations
Maximum number of permutations for discrete / manufacturable values.
Type

int

Read Only

Yes

MaxNumCandidates
Maximum Number of Candidates
Type

int

Read Only

MaxNumIterations
Maximum Number of Iterations
Type

int

Read Only

NumberOfEvaluations
Number of Evaluations
Type

int

Read Only

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

Design Exploration

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

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

Properties
ConstraintFirstValue
Constraint First Value used when ConstraintType is eGI_LessThanTarget, eGI_GreaterThanTarget,
eGI_NearTarget or eGI_InsideBounds.
Type

double

Read Only

ConstraintHandling
Constraint Handling
Type

ConstraintHandlingType

Read Only

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

ConstraintImportance
Importance of the constraint when multiple objectives are defined.
Type

ImportanceLevel

Read Only

ConstraintSecondValue
Constraint Second Value used when ConstraintType is eGI_InsideBounds.
Type

double

Read Only

ConstraintType
Constraint type for the Parameter to be optimized.
Type

ConstraintType

Read Only

HistoryChart
DataReference of the associated history chart entity.
Type

DataReference

Read Only

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

double

Read Only

ObjectiveImportance
Importance of the objective when multiple objectives are defined.
Type

ImportanceLevel

Read Only

ObjectiveTargetValue
Objective Target Value if ObjectiveType is SeekTarget.
Type

double

Read Only

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

Design Exploration

ObjectiveType
Objective type for the Parameter to be optimized.
Type

GoalType

Read Only

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

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

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")

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

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

string

Read Only

ExportDesignPoints
If True and PreserveDesignPoints is True as well, export project for each preserved Design Points.
Type

bool

Read Only

Method
Optimization Method
Type

DataReference

Read Only

MethodName
Type of the optimization
Type

string

Read Only

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

int

Read Only

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

Design Exploration

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

bool

Read Only

RetainDesignPoints
If True and PreserveDesignPoints is True as well, retain data for each preserved Design Points.
Type

bool

Read Only

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

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

bool

Read Only

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.
The DataReference of the Chart.

Return

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 CorrelationModel 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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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()

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.
The created entity.

Return

Type

DataReference

Optional Arguments
DisplayText

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

Expressions

string

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.

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

Design Exploration
Type
RightExpression

string

Right Expression.
Type

Type

string

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="PR
parameterRelationship2 = model.CreateParameterRelationship(LeftExpression="P4+P5",RightExpression="10[inch]",T

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()

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

customCandidatePoint1 = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 1")

customCandidatePoint2 = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 2")
model.DeleteCustomCandidatePoints(CustomCandidatePoints=[customCandidatePoint1, customCandidatePoint2])

DeleteOptimizationCriteria
Deletes a list of OptimizationCriterion entities.
Required Arguments
OptimizationCriteria

List of Objective entities to delete.

List<DataReference>

Type

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()
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

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

Design Exploration
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

TargetModel

string

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

TargetResponsePoint

DataReference

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()

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

FileName

List<DataReference>

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

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.
The DataReference of the CandidatePoint entity.

Return

Type

DataReference

Required Arguments
Name Name of the CandidatePoint to retrieve.
Type

string

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.
The DataReferenceSet of the CandidatePoint entities.

Return

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

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

Design Exploration
Required Arguments
Name Name of the chart.
Type

string

GetConvergenceChart
Query to return the chart reference for a given model and chart name.
The DataReference of the chart.

Return

Type

DataReference

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

Return

Type

DataReference

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()

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

GetOptimizationCriteria
Get the DataReferenceSet of all of the existing OptimizationCriterion entities of the model.
The DataReference of the OptimizationCriterion entities.

Return

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 OptimizationCriterion entities.
system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
criteria = model.GetOptimizationCriteria()

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

Return

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

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

Design Exploration
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.
The DataReferenceSet of the ParameterRelationship entities.

Return

Type

DataReferenceSet

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 argument 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

100

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.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

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", "MinDesignPoints", "MaxDesignPoints", "ResponsePoints", "DeterminationMatrix".
The DataReference of the ParametricTable

Return

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")

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 retrieved 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

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

101

Design Exploration
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="VariationToRefere

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.

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.

102

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

Type

string

Read Only

FTestFiltering
F-Test Filtering (beta)
Type

bool

Read Only

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

bool

Read Only

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

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

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

103

Design Exploration

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.
The DataReference of the OptimizationCriterion.

Return

Type

DataReference

Required Arguments
Parameter

The parameter on which the criterion is created.

Type

DataReference

Return

Type

DataReference

Required Arguments
Parameter

Parent Parameter.
Type

104

DataReference

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

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

Return

Type

DataReference

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

ErrorMessage
Error Message associated to the Parameter Relationship.
Type

string

Read Only

Yes

LeftExpression
Left Expression of Parameter Relationship.

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

105

Design Exploration
Type

string

Read Only

LeftExpressionQuantityName
Quantity Name of Left Expression of Parameter Relationship.
Type

string

Read Only

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

Read Only

RightExpression
Right Expression of Parameter Relationship.
Type

string

Read Only

RightExpressionQuantityName
Quantity Name of Right Expression of Parameter Relationship.
Type

string

Read Only

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

string

Read Only

Yes

106

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

Methods
DuplicateParameterRelationship
Duplicates a Parameter Relationship.
The created entity.

Return

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)

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.

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

107

Design Exploration

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

ScreeningOptimization
Entity which performs and manages the DesignXplorer Optimization Method Component

Properties
Converged
Convergence state
Type

bool

Read Only

Yes

string

Read Only

MaximumNumberOfPermutations
Maximum number of permutations for discrete / manufacturable values.
Type
108

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

Read Only

Yes

MaxNumCandidates
Maximum Number of Candidates
Type

int

Read Only

NumberOfEvaluations
Number of Evaluations
Type

int

Read Only

Yes

NumberOfFailures
Number of Failures
Type

int

Read Only

Yes

NumberOfSamples
Number of Samples
Type

int

Read Only

NumCandidates
Number of Candidates
Type

int

Read Only

Yes

SampleSetSize
Size of Generated Sample Set
Type

int

Read Only

Yes

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

109

Design Exploration

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.

string

Read Only

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.
Results of the query telling if the Point entity can be updated to produce
the specified source of output values.

Return

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")

110

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

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.
The dictionary of the input parameter values.

Return

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.
The dictionary of the output parameter values.

Return

Type

ReadOnlyDictionary<DataReference, Object>

Optional Arguments
Source

The source of the output values to return.

ValueType

Type

OutputSource

Default Value

Simulation

The type of parameter value to return.

Type

ParameterValueType

Default Value

ActualValue

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

111

Design Exploration
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.
State for the specified nature of output values.

Return

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.
The retrieve parameter value.

Return

Type

Object

Required Arguments
Parameter

The Parameter for which the value is requested.

Type

DataReference

Optional Arguments
Source

ValueType

112

If Parameter is an output parameter, the source of the output value to return.

Type

OutputSource

Default Value

Simulation

The type of parameter value to return.

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

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.
The dictionary of the parameter values.

Return

Type

ReadOnlyDictionary<DataReference, Object>

Optional Arguments
Source

For output parameters, the source of the output values to return.

ValueType

Type

OutputSource

Default Value

Simulation

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,
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

113

Design Exploration
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.
The dictionary of parameters with their values.

Return

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
charts properties to control the visibility of each axis, feasible samples, candidates youve inserted
manually, and candidates with verified output values.

Properties
CandidatesColoringMethod
Coloring method used to draw the chart.
Type

CandidatesColoringMethods

Read Only

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

114

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

ShowCandidates
If True, the candidates are displayed on the chart.
Type

bool

Read Only

ShowCustomCandidates
If True, any custom candidates are displayed on the chart.
Type

bool

Read Only

ShowSamples
If True, the samples are displayed on the chart.
Type

bool

Read Only

ShowStartingPoint
If True, the starting point is displayed on the chart.
Type

bool

Read Only

ShowVerifiedCandidates
If True, any verified candidates are displayed on the chart.
Type

bool

Read Only

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

115

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()

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

116

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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()

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".
Type

bool

Read Only

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

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

117

Design Exploration

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 ConvergenceCriteria 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.
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)

118

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

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 Yaxis. 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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

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>

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

119

Design Exploration
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()

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

120

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

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

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>

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

121

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

122

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

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

LinearTrendLine_Variable
The DataReference of the LinearTrendLine variable.
Type

DataReference

Read Only

QuadraticTrendLine_Variable
The DataReference of the QuadraticTrendLine variable.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

123

Design Exploration
Type

DataReference

Read Only

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")

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 ConvergenceCriteria chart.
124

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

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 )

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

CustomCandidatePoint
The CustomCandidatePoint data entity is a candidate point created and edited by the user for comparison with the results of an optimization.

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

125

Design Exploration

string

Read Only

Return

Type

bool

Optional Arguments
Source

Source of the output values to query for.

Type

OutputSource

Default Value

Simulation

Return

Type

ReadOnlyDictionary<DataReference, Object>

Optional Arguments
ValueType

126

The type of parameter value to return.

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

Type

ParameterValueType

Default Value

ActualValue

GetOutputValues
Get the values of the output parameters for the specified source of output values.
The dictionary of the output parameter values.

Return

Type

ReadOnlyDictionary<DataReference, Object>

Optional Arguments
Source

The source of the output values to return.

ValueType

Type

OutputSource

Default Value

Simulation

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

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

127

Design Exploration
Optional Arguments
Source

Source of output values to query for.

Type

OutputSource

Default Value

Simulation

Return

Type

Object

Required Arguments
Parameter

The Parameter for which the value is requested.

Object

DataReference of the parameter.

Type

DataReference

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

129

Design Exploration
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]"})

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.
The dictionary of parameters with their values.

Return

Type

ReadOnlyDictionary<DataReference, Object>

Optional Arguments
Source

130

Source of output values to produce. The update method depends on this parameter.
Type

OutputSource

Default Value

Simulation

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

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

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

131

Design Exploration

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

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

132

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

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)

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

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

133

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>

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

134

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

DeterminationHistogramChart
The data entity which describes the Determination Histogram chart. It allows you to visualize the coefficient 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

Read Only

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

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

135

Design Exploration
Type

string

Read Only

FullModelR2
Full Model R2 value.
Type

double

Read Only

Yes

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

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

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

136

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

chart.AssociateParameterToAxis(Parameter=inputParam1, Axis="XAxis")
chart.AssociateParameterToAxis(Parameter=outputParam1, Axis="YAxis")
chart.AssociateParameterToAxis(Parameter=outputParam2, Axis="YRightAxis")

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

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.

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

137

Design Exploration

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

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>

138

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

chart.EnableParameters( Parameters=[param1;param4], IsEnabled=false )

chart.EnableParameters()

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

DistributionChart
The entity which describes a parameter's Distribution chart. This chart is always associated with an uncertainty parameter and allows you to visualize the statistical distribution defined or calculated for this
parameter.

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

139

Design Exploration

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

Parameter
The parameter entity associated with the chart.
Type

DataReference

Read Only

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.

140

Type

bool

Default Value

False

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

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

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

141

Design Exploration
Read Only

Methods
CreateAdvancedReport
For the standard response surface only (Full second order Polynomials), creates an Advanced Goodness
of Fit report for any direct output parameter.
A string which contains the generated Advanced Goodness of Fit report.

Return

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.
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

Expression

DataReference

Assigned Expression (discrete value).

Type

string

Example
The following example shows how to set the expression for one discrete parameter in an existing
GoodnessOfFit.

142

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

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()

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

string

Read Only

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

143

Design Exploration

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

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

144

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

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

Mode
Specifies the graphical representation used to render local sensitivity data. It can be either BarChart or
PieChart.
Type

SensitivityChartModes

Read Only

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.

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

145

Design Exploration
Type

bool

Optional Arguments
Parameters

Parameters to enable or disable, or all parameters if not specified.

Type

List<DataReference>

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

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.

146

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

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 enabling 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

AxesRangeMode
Axes range for output parameters controls if the range is determined from the chart's data or the minmax of outputs.
Type

AxesRangeModes

Read Only

ChartResolution
Chart resolution.
Type

int

Read Only

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

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

147

Design Exploration

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

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

EnableParameters
Enable or disable a list of parameters in a chart.
Required Arguments
IsEnabled

148

False to disable the parameters, or True (default) to enable them.

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

Type

bool

Optional Arguments
Parameters

Parameters to enable or disable, or all parameters if not specified.

Type

List<DataReference>

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

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

149

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()

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

string

Read Only

Entropy
Shannon Entropy value (Complexity)
Type

double

Read Only

InvProbabilityTable
DataReference of the Inverse Probability ParametricTable for the associated parameter
Type

DataReference

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

Kurtosis
Kurtosis value
Type

double

Read Only

150

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

Mean
Mean value
Type

double

Read Only

Parameter
DataReference of the input or output parameter associated with this statistics entity.
Type

DataReference

Read Only

ProbabilityTable
DataReference of the Probability ParametricTable for the associated parameter
Type

DataReference

Read Only

SigmaMaximum
Sigma Maximum value
Type

double

Read Only

SigmaMinimum
Sigma Minimum value
Type

double

Read Only

SignalNoiseLarge
Signal-Noise Ratio value (Larger is Better)
Type

double

Read Only

SignalNoiseNominal
Signal-Noise Ratio value (Nominal is Best)
Type

double

Read Only

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

151

Design Exploration

SignalNoiseSmall
Signal-Noise Ratio value (Smaller is Better)
Type

double

Read Only

Skewness
Skewness value
Type

double

Read Only

StandardDeviation
Standard Deviation value
Type

double

Read Only

StatisticsChart
DataReference of the statistics chart for the associated parameter
Type

DataReference

Read Only

TableType
Type of the probability table
Type

SixSigmaTableTypes

Read Only

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

152

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

DimRow
Number of rows.
Type

int

Read Only

Yes

string

Read Only

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.
container = system1.GetContainer(ComponentName="Design of Experiment")
model = container.GetModel()
DOEMatrix = model.GetParametricTable(Name="DesignPoints")

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

153

Design Exploration
DOEMatrix.DeleteRows(Indices=[0,7,8,9])

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

GetCellValue
Get the Value of a ParametricTable's cell. An exception is thrown if the entity is not found.
The value of the cell.

Return

Type

string

Required Arguments
ColumnIndex

ColumnIndex (zero-based) of the cell.

Type

RowIndex

int

RowIndex (zero-based) of the cell.

Type

int

154

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

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.
The value of the update order.

Return

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.
List of the values of the specified row.

Return

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

155

Design Exploration
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

RowIndex

Zero-based row index of the cell.

Type

Value

int

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 refinement 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

156

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

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

UpdateOrder

int

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

RowValues

int

New values for the row.

Type

List<string>

Release 15.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 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 Experiments 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()
parametricTable1 = responseSurfaceModel1.GetParametricTable(Name="VerificationPoints")
parametricTable1.UpdateRows(Indices=[0,1])

158

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

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

ShowDesignPoints
Option to display the design points.
Type

bool

Read Only

ShowVerificationPoints
Option to display the verification points.
Type

bool

Read Only

Methods
EnableParameters
Enable or disable a list of parameters in a chart.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

159

Design Exploration
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>

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

160

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

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

ChartResolutionAlongX
Chart resolution along the X axis.
Type

int

Read Only

ChartResolutionAlongY
Chart resolution along the Y axis.
Type

int

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

161

Design Exploration

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

Mode
Response chart mode: 2D, 3D or 2D Slices.
Type

ResponseChartModes

Read Only

NumberOfSlices
Number of slices for the 2D Slices mode.
Type

int

Read Only

ShowDesignPoints
Option to display the design points of the DOE and the refinement points.
Type

bool

Read Only

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

162

ChartAxes

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

Optional Arguments
Parameter

Parameter entity to be assigned to the specified axis.

Type

DataReference

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

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

163

ResponsePoint
The ResponsePoint data entity: a design point for which output values are computed from a Response
Surface.

string

Read Only

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

Note
User notes about the response point.
Type

string

Read Only

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

164

The DataReference of the Chart.

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

Type

DataReference

Required Arguments
ChartType

Type of chart to be created. The possible values are "eChartLocalSensitivity", "eChartLocalSensitivityCurves", "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.
The DataReference of the Chart.

Return

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

TargetResponsePoint

string

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.

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

165

Design Exploration

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.
The DataReference of the Chart entity.

Return

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.
The DataReferences of the Chart entities.

Return

Type

DataReferenceSet

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

166

Dictionary of the discrete input parameters and their assigned expressions.

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

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

Parameter

string

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]")

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 ResponsePoint.
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

167

Design Exploration
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.
Type

ChartColoringMethods

Read Only

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

168

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

Mode
Samples chart mode.
Type

SamplesChartModes

Read Only

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

ShowInfeasiblePoints
If True, any infeasible points are displayed on the chart.
Type

bool

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

169

Design Exploration
Optional Arguments
Parameters

Parameters to enable or disable, or all parameters if not specified.

Type

List<DataReference>

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

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.

170

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

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

Mode
Specifies the graphical representation used to render local sensitivity data. It can be either BarChart or
PieChart.
Type

SensitivityChartModes

Read Only

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

171

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>

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

172

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

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

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

173

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>

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

174

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

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

string

Read Only

FittingDistributionType
Statistics chart plot type.
Type

CdfPlotType

Read Only

IsUpToDate
True if the entity is up-to-date.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

175

Design Exploration
Type

bool

Read Only

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

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.
176

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

Mode
Chart mode, either 2D or 3D.
Type

TradeoffChartModes

Read Only

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

ShowInfeasiblePoints
If True, any infeasible points are displayed on the chart.
Release 15.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

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

The exported file name.

Type

string

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

178

Type

bool

Default Value

False

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

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.
The DataReference of the Model.

Return

Type

DataReference

Data Entities
DiscreteLevel
The data entity which describes a Discrete Level of an Input Parameter.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

179

Design Exploration

string

Read Only

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

int

Read Only

Value
Value of the DiscreteLevel.
Type

Object

Read Only

Value set to the discrete level entity.

Type

Object

180

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

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

Parameter
The parameter entity associated with the chart.
Type

DataReference

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

181

Design Exploration
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)

DOEModel
Entity which performs and manages the DesignXplorer Design Of Experiments Component

Properties
CCDTemplateType
Template Type for CCD algorithm.
Type

CCDTemplateType

Read Only

CCDType
Design Type for CCD algorithm.
Type

CentralCompositeDesignType

Read Only

string

Read Only

182

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

ExportDesignPoints
If True and PreserveDesignPoints is True as well, export project for each preserved Design Points.
Type

bool

Read Only

MaxNumCycles
Maximum Number Of Cycles for OSFD algorithm.
Type

int

Read Only

Method
Optimization Method
Type

DataReference

Read Only

MethodName
Type of the Design of Experiments
Type

string

Read Only

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

int

Read Only

NumSamp
Number of Samples for User-Defined OSFD algorithm.
Type

int

Read Only

OSFDType
Design Type for OSFD algorithm.
Type

OptimalSpaceFillingType

Read Only

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

183

Design Exploration

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

bool

Read Only

RandomGeneratorSeed
Seed value for LHS and OSFD algorithm.
Type

int

Read Only

RetainDesignPoints
If True and PreserveDesignPoints is True as well, retain data for each preserved Design Points.
Type

bool

Read Only

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

SampType
Samples Type for LHS and OSFD algorithm.
Type

NumSampType

Read Only

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

184

DataReference

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

Required Arguments
ChartType

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

DeleteCharts
Deletes a list of Chart entities.
Required Arguments
Charts

List of Chart entities to delete.

Type

List<DataReference>

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.
The DataReference of the Chart.

Return

Type

DataReference

Required Arguments
Chart

The source chart to duplicate.

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

185

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

TargetModel

string

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

TargetResponsePoint

DataReference

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

DataReference

GetChart
Query to return the chart reference for a given model and chart name.
The DataReference of the chart.

Return

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.
The DataReference of the Parameter.

Return

Type

DataReference

Required Arguments
Name Name of the Parameter.
Type

186

string

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

Return

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

Return

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.

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

187

Design Exploration

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

ExpandRanges

List<DataReference>

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.
Required Arguments
FileName

The imported file name.

Type

string

Optional Arguments
ExpandRanges

188

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
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

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.
The DataReference of the ParametricTable containing the generated
data.

Return

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.

double

Read Only

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

189

Design Exploration

double

Read Only

ConstantValue
Constant value of the Parameter when it is disabled.
Type

Object

Read Only

DiscreteLevels
List of the discrete levels.
Type

List<DataReference>

Read Only

Yes

string

Read Only

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

double

Read Only

DistributionType
Distribution type for an uncertainty parameter.
Type

DistType

Read Only

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

190

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

Read Only

Enabled
True if the Parameter is enabled for the current study.
Type

bool

Read Only

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

Mean
Mean value of the distribution for an uncertainty parameter.
Type

double

Read Only

Yes

Nature
Nature of the Parameter.
Type

ParameterNature

Read Only

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
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

191

Design Exploration
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

Read Only

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

bool

Read Only

192

The created entity.

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

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

Index

string

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

int

Type

DataReference

DeleteDiscreteLevels
Deletes a list of levels from a discrete input parameter.
Required Arguments
DiscreteLevels

List of the DiscreteLevel entities to delete.

DataReference

196

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

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

OutputParameter
Output parameter entity for DesignXplorer.

string

Read Only

FTestFiltering
F-Test Filtering (beta)
Type

bool

Read Only

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

bool

Read Only

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

double

Read Only

Yes

double

Read Only

PredictedRelativeError
Current value of the Predicted Relative Error when refining with the Kriging algorithm
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

197

Design Exploration
Type

double

Read Only

Yes

TransformationType
Transformation Type
Type

TransformationType

Read Only

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.
The DataReference of the OptimizationCriterion.

Return

Type

DataReference

Required Arguments
Parameter

The parameter on which the criterion is created.

Type

DataReference

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

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

The DataReference of the OptimizationCriterion.

Return

Type

DataReference

Required Arguments
Parameter

Parent Parameter.
Type

DataReference

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

Return

Type

DataReference

SamplingMethod
Entity which wraps and manages the external Sampling Method for the Design of Experiments component

Properties
No Properties.

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

199

Design Exploration

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.
The DataReference of the Model.

Return

Type

DataReference

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

string

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

200

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

Read Only

Return

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

DataReference of the Discrete Input parameter.

Type

Expression

DataReference

Assigned Expression (discrete value).

Type

string

Example
The following example shows how to set the expression for one discrete parameter in an existing
GoodnessOfFit.

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

201

Design Exploration

container = system1.GetContainer(ComponentName="Response Surface")

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

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

double

Read Only

double

Read Only

202

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

ConstantValue
Constant value of the Parameter when it is disabled.
Type

Object

Read Only

DiscreteLevels
List of the discrete levels.
Type

List<DataReference>

Read Only

Yes

string

Read Only

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

double

Read Only

DistributionType
Distribution type for an uncertainty parameter.
Type

DistType

Read Only

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

double

Read Only

Enabled
True if the Parameter is enabled for the current study.
Type

bool

Read Only

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

203

Design Exploration

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

Mean
Mean value of the distribution for an uncertainty parameter.
Type

double

Read Only

Yes

Nature
Nature of the Parameter.
Type

ParameterNature

Read Only

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

204

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

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

Read Only

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

bool

Read Only

Return

Type

DataReference

Required Arguments
Value

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

Type

Object

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

205

Design Exploration
Optional Arguments
DisplayText

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

Index

DataReference

Required Arguments
Name The name of the discrete level.
Type

208

string

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

Return

Type

DataReference

Required Arguments
Parameter

Parent Parameter.
Type

DataReference

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

The DataReference of the ParameterStatistics entity.

Type

DataReference

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

209

Design Exploration

MinMaxSearch
The data entity which described the MinMax Search option of a Response Surface Component.

string

Read Only

Enabled
If True, performs a min-max search performed when the response surface is built.
Type

bool

Read Only

IsUpToDate
True if the entity is up-to-date.
Type

bool

Read Only

NumberInitialPoints
Number of initial samples for the min-max search algorithm.
Type

int

Read Only

NumberStartPoints
Number of start points for the min-max search algorithm.
Type

int

Read Only

OutputParameter
Output parameter entity for DesignXplorer.

210

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

string

Read Only

FTestFiltering
F-Test Filtering (beta)
Type

bool

Read Only

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

bool

Read Only

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

double

Read Only

Yes

double

Read Only

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

double

Read Only

Yes

TransformationType
Transformation Type
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

211

Design Exploration
Type

TransformationType

Read Only

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.
The DataReference of the OptimizationCriterion.

Return

Type

DataReference

Required Arguments
Parameter

The parameter on which the criterion is created.

Type

DataReference

Return

Type

DataReference

Required Arguments
Parameter
212

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

Type

DataReference

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

Return

Type

DataReference

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

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

213

Design Exploration

string

Read Only

Methods
AddRow
Adds a row to the bottom of a ParametricTable entity.
Optional Arguments
RowValues

New values for the row.

Type

List<string>

DeleteRows
Delete rows from a ParametricTable entity.
Required Arguments
Indices

Indices of the rows to delete.

Type

List<int>

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.

214

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

GetCellValue
Get the Value of a ParametricTable's cell. An exception is thrown if the entity is not found.
The value of the cell.

Return

Type

string

Required Arguments
ColumnIndex

ColumnIndex (zero-based) of the cell.

Type

RowIndex

int

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.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

215

Design Exploration
The value of the update order.

Return

Type

double

Required Arguments
RowIndex

RowIndex (zero-based) of the cell.

Type

int

GetRowValues
Get the Values of a ParametricTable's row. An exception is thrown if the entity is not found.
List of the values of the specified row.

Return

Type

List<string>

Required Arguments
RowIndex

RowIndex (zero-based) of the row to retrieve.

Type

int

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()

216

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

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

RowIndex

Zero-based row index of the cell.

Type

Value

int

New value of the cell.

Type

string

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>

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

217

Design Exploration
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

UpdateOrder

int

New value of the update order.

Type

double

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

RowValues

int

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()

218

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

DOEMatrix.SetRowValues(RowIndex=0, RowValues=[ "12.5 [mm]", "1" ] )

Definition of the sort.

Type

List<string>

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>

ResponseSurfaceModel
Entity which performs and manages the DesignXplorer Response Surface Component

Properties
Converged
Convergence state

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

219

Design Exploration
Type

bool

Read Only

Yes

CrowdingDistSeparationPercentage
Crowding Distance Separation Percentage when refining with the Kriging algorithm
Type

double

Read Only

CurrentRelativeError
Current value of the Relative Error
Type

double

Read Only

Yes

string

Read Only

ExportDesignPoints
If True and PreserveDesignPoints is True as well, export project for each preserved Design Points.
Type

bool

Read Only

FittingType
Response Surface Type
Type

FittingType

Read Only

GenerateVerificationPoints
If True, generate verification points.
Type

bool

Read Only

KernelVariationType
Kernel Variation Type for the Kriging algorithm

220

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

Type

KernelVariationType

Read Only

MaximumDepth
Maximum Depth limit when refining with the Sparse Grid response surface
Type

int

Read Only

MaximumRelativeErrorSparseGrid
Maximum Relative Error targeted when refining with the Sparse Grid response surface
Type

double

Read Only

MaxNumberRefinementPointsKriging
Maximum Number Of Refinement Points that can be generated for refinement with the Kriging algorithm.
Type

int

Read Only

MaxNumberRefinementPointsSparseGrid
Maximum Number Of Refinement Points that can be generated for refinement with the Sparse Grid
response surface
Type

int

Read Only

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.
Type

double

Read Only

NumberOfCells
Number of Cells for the Neural Network algorithm
Type

int

Read Only

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

221

Design Exploration

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

int

Read Only

NumberRefinementPoints
Number Of existing Refinement Points
Type

int

Read Only

Yes

NumberVerificationPoints
Number of verification points to generate.
Type

int

Read Only

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

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

double

Read Only

Yes

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

bool

Read Only

RefinementType
Refinement Type
Type

222

ResponseSurfaceRefinementType

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

Read Only

RetainDesignPoints
If True and PreserveDesignPoints is True as well, retain data for each preserved Design Points.
Type

bool

Read Only

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

Return

Type

DataReference

Required Arguments
ChartType

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

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

223

Design Exploration

CreateGoodnessOfFit
Creates a GoodnessOfFit. The ParameterValues dictionary can be used to specify a value for some or
all of the discrete input parameters.
The created entity.

Return

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

ParameterValues

string

The values for each discrete input parameter. If not specified, each parameter is initialized 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.
The created entity.

Return

Type

DataReference

Optional Arguments
DisplayText

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

ParameterValues

The values for each input parameter. If not specified, each parameter is initialized to
the middle of its variation range.
Type

224

string

IDictionary<DataReference, string>

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

TargetModel

string

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

TargetResponsePoint

DataReference

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

DataReference

226

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

DuplicateGoodnessOfFit
Duplicates a GoodnessOfFit.
The created entity.

Return

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

TargetModel

string

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.
The created entity.

Return

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.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

227

Design Exploration
Type
DuplicateCharts

TargetModel

string

True if the charts of the response point have to be duplicated.

Type

bool

Default Value

False

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=Tru
responsePoint2.Update()

GetChart
Query to return the chart reference for a given model and chart name.
The DataReference of the chart.

Return

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.
The DataReference of the GoodnessOfFit.

Return

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")

228

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

responseSurfaceModel1 = responseSurface1.GetModel()
gof = responseSurfaceModel1.GetGoodnessOfFit(Name="GoodnessOfFit")

GetGoodnessOfFits
Get the DataReferences of the GoodnessOfFit entities associated with a Model.
The DataReferences of the GoodnessOfFits.

Return

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 exception is thrown if the entity is not found.
The DataReference of the MinMaxSearch entity.

Return

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.
The DataReference of the Parameter.

Return

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.

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

229

Design Exploration

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

Return

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

Return

Type

DataReference

Required Arguments
Name Name of the ParametricTable
Type

string

230

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

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.
The DataReference of the ResponsePoint.

Return

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.
The DataReferences of the ResponsePoints

Return

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()

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")

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

231

Design Exploration
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")

Return

Type

DataReference

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

232

DataReference

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

Data Entities
CorrelationModel
Entity which performs and manages the DesignXplorer Parameters Correlation Component

Properties
AutoStopType
Auto Stop Type
Type

CorrelationAutoStopType

Read Only

Converged
Convergence state
Type

bool

Read Only

Yes

ConvergenceCheckFrequency
Convergence Check Frequency
Type

int

Read Only

string

Read Only

ExportDesignPoints
If True and PreserveDesignPoints is True as well, export project for each preserved Design Points.
Type

bool

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

233

Design Exploration
Read Only

LinearCorrelationType
Correlation Type
Type

LinearCorrelationType

Read Only

MeanValueAccuracy
Mean Value Accuracy
Type

double

Read Only

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

int

Read Only

NumberSamples
Number of Samples
Type

int

Read Only

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

bool

Read Only

RestartMode
True to reuse the samples already generated
Type

bool

Read Only

RetainDesignPoints
If True and PreserveDesignPoints is True as well, retain data for each preserved Design Points.
Type

234

bool

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

Read Only

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

SampleSetSize
Size of Generated Sample Set
Type

int

Read Only

Yes

StandardDeviationAccuracy
Standard Deviation Accuracy
Type

double

Read Only

Return

Type

DataReference

Required Arguments
ChartType

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.

Release 15.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="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>

Return

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

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

TargetResponsePoint

DataReference

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

236

string

DataReference

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

GetChart
Query to return the chart reference for a given model and chart name.
The DataReference of the chart.

Return

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.
The DataReference of the Parameter.

Return

Type

DataReference

Required Arguments
Name Name of the Parameter.
Type

string

The DataReferences of the Parameters

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

237

Design Exploration
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

Return

Type

DataReference

Required Arguments
Name Name of the ParametricTable
Type

string

The DataReference of the ParametricTable containing the generated

data.
Type

238

DataReference

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

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

double

Read Only

double

Read Only

ConstantValue
Constant value of the Parameter when it is disabled.
Type

Object

Read Only

DiscreteLevels
List of the discrete levels.
Type

List<DataReference>

Read Only

Yes

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

239

Design Exploration
Read Only

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

double

Read Only

DistributionType
Distribution type for an uncertainty parameter.
Type

DistType

Read Only

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

double

Read Only

Enabled
True if the Parameter is enabled for the current study.
Type

bool

Read Only

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

Mean
Mean value of the distribution for an uncertainty parameter.
Type

240

double

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

Read Only

Yes

Nature
Nature of the Parameter.
Type

ParameterNature

Read Only

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.

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

241

Design Exploration
Type

double

Read Only

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

bool

Read Only

Return

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

Index

string

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

int

Default Value

-1

242

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

DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")

List of added levels.

Type

List<string>

Optional Arguments
Overwrite

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

Type

bool

CreateOptimizationCriterion
Creates an OptimizationCriterion entity associated to a parameter.
The DataReference of the OptimizationCriterion.

Return

Type

DataReference

Required Arguments
Parameter

The parameter on which the criterion is created.

Type

DataReference

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

243

Design Exploration

DeleteDiscreteLevels
Deletes a list of levels from a discrete input parameter.
Required Arguments
DiscreteLevels

List of the DiscreteLevel entities to delete.

Type

List<DataReference>

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>

The exported file name.

Type

244

string

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

Return

Type

DataReference

Required Arguments
Name The name of the discrete level.
Type

string

Return

Type

DataReference

Required Arguments
Parameter

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

245

Design Exploration
Type

DataReference

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

Return

Type

DataReference

OutputParameter
Output parameter entity for DesignXplorer.

string

Read Only

FTestFiltering
F-Test Filtering (beta)
Type

bool

Read Only

246

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

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

bool

Read Only

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

double

Read Only

Yes

double

Read Only

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

Units
Units
Type

string

Read Only

Yes

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

double

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

247

Design Exploration
Read Only

Yes

Methods
CreateOptimizationCriterion
Creates an OptimizationCriterion entity associated to a parameter.
The DataReference of the OptimizationCriterion.

Return

Type

DataReference

Required Arguments
Parameter

The parameter on which the criterion is created.

Type

DataReference

Return

Type

DataReference

Required Arguments
Parameter

Parent Parameter.
Type

DataReference

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

248

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

The DataReference of the ParameterStatistics entity.

Return

Type

DataReference

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.
The DataReference of the Model.

Return

Type

DataReference

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

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

249

Design Exploration
Read Only

double

Read Only

ConstantValue
Constant value of the Parameter when it is disabled.
Type

Object

Read Only

DiscreteLevels
List of the discrete levels.
Type

List<DataReference>

Read Only

Yes

string

Read Only

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

double

Read Only

DistributionType
Distribution type for an uncertainty parameter.
Type

DistType

Read Only

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

250

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

Type

double

Read Only

Enabled
True if the Parameter is enabled for the current study.
Type

bool

Read Only

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

Mean
Mean value of the distribution for an uncertainty parameter.
Type

double

Read Only

Yes

Nature
Nature of the Parameter.
Type

ParameterNature

Read Only

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.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

251

Design Exploration
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

Read Only

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

bool

Read Only

252

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

The created entity.

Return

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

Index

string

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

int

Default Value

-1

List of added levels.

Type

List<string>

Optional Arguments
Overwrite

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

Type

bool

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

253

Design Exploration
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.
The DataReference of the OptimizationCriterion.

Return

Type

DataReference

Required Arguments
Parameter

The parameter on which the criterion is created.

Type

DataReference

DeleteDiscreteLevels
Deletes a list of levels from a discrete input parameter.
Required Arguments
DiscreteLevels

List of the DiscreteLevel entities to delete.

Type

List<DataReference>

254

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

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>

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

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.

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

255

Design Exploration
The DataReference of the discrete level entity.

Return

Type

DataReference

Required Arguments
Name The name of the discrete level.
Type

string

Return

Type

DataReference

Required Arguments
Parameter

Parent Parameter.
Type

DataReference

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.
256

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

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.

string

Read Only

FTestFiltering
F-Test Filtering (beta)
Type

bool

Read Only

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

bool

Read Only

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

double

Read Only

Yes

double

Read Only

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

257

Design Exploration

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

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.
The DataReference of the OptimizationCriterion.

Return

Type

DataReference

Required Arguments
Parameter

The parameter on which the criterion is created.

Type

DataReference

258

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

Return

Type

DataReference

Required Arguments
Parameter

Parent Parameter.
Type

DataReference

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

Return

Type

DataReference

SixSigmaModel
Entity which performs and manages the Six Sigma Analysis Component

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

259

Design Exploration
Type

string

Read Only

ExportDesignPoints
If True and PreserveDesignPoints is True as well, export project for each preserved Design Points.
Type

bool

Read Only

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

int

Read Only

NumSamp
Number of Samples
Type

int

Read Only

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

bool

Read Only

RetainDesignPoints
If True and PreserveDesignPoints is True as well, retain data for each preserved Design Points.
Type

bool

Read Only

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

SampleGenType
Sampling Type

260

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

Type

SampleGenType

Read Only

Return

Type

DataReference

Required Arguments
ChartType

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

DeleteCharts
Deletes a list of Chart entities.
Required Arguments
Charts

List of Chart entities to delete.

Type

List<DataReference>

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

261

Design Exploration
model.DeleteCharts(Charts=[chart1, chart2])

Return

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

TargetModel

string

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

TargetResponsePoint

DataReference

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

DataReference

GetChart
Query to return the chart reference for a given model and chart name.
The DataReference of the chart.

Return

Type

DataReference

Required Arguments
Name Name of the chart.
Type
262

string
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
The DataReference of the Parameter.

Return

Type

DataReference

Required Arguments
Name Name of the Parameter.
Type

string

Return

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

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

263

Design Exploration
The DataReference of the ParametricTable

Return

Type

DataReference

Type

string

Optional Arguments
ApplyScaleOffset

IgnoreSuppressed

OverwriteTarget

ReplaceMaterial

The flag to specify if the scale factor and offset value will be applied during export.
Type

bool

Default Value

False

The flag to specify if suppressed engineering data will be ignored during export.
Type

bool

Default Value

False

The flag to specify if the target file will be overwritten.

Type

bool

Default Value

False

The flag to specify if the earlier material data will be replaced in case of similar
material names.
Type

bool

Default Value

False

Example
template = GetTemplate(TemplateName="EngData") system = template.CreateSystem(Position="Default")
container = system.GetContainer(ComponentName="Engineering Data") materials = container.GetMaterials() EngData.WriteMaterials(MaterialList=materials, FilePath=r"d:\data\OutputMaterials.xml",
Format="MatML31", UnitSystem="MKS_STANDARD", ReplaceMaterial=true)

266

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
A DataReferenceSet of the materials in the container.

Return

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

267

Engineering Data
Type

DataReference

Required Arguments
Name

The name of the material to read from the source.

Type

Source

string

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.

268

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

DependentPropertyColl
The collection of experimental test data, e.g., Uniaxial Test data (Engineering Strain Vs Engineering
Stress).
Type

DataReferenceSet

Read Only

string

Read Only

UnitSystemWhenSolved
The unit system of the coefficients of material model.
Type

string

Type

272

int

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

Optional Arguments
SheetName

Name of the sheet to access.

Type

SheetQualifiers

string

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 Sh
#
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

ColumnMajor

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

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

273

Engineering Data
EndIndex

SheetName

The end index for requesting a subset of the data (zero-based).

Type

int

Default Value

-2147483647

Specifies the sheet name when the data contains multiple sheets.
Type

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

StartIndex

Variables

string

Dictionary<string, string>

The start index for requesting a subset of the data (zero-based).

Type

int

Default Value

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

274

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 "Variables".
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Type
Index

Dictionary<string, List<Object>>

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.

SheetName

Type

int

Default Value

Specifies the sheet name when the data contains multiple sheets.
Type

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

Values

string

Dictionary<string, string>

List of data values set in conjunction with the "Variables" parameter. This parameter
and the "Data" parameter are mutually exclusive.
Type

Variables

List<List<Object>>

Names of the variables for which data is being set. This parameter and and the "Data"
parameter are mutually exclusive.
Type

List<string>

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

275

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

Value

string

The new value.

Type

string

Optional Arguments
SheetName

The name of the tabular data sheet that contains the qualifier.
Type

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

VariableName

Dictionary<string, string>

The name of the Variable that contains the qualifier to be changed.

Type

VariableQualifiers

string

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(

276

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

DisplayName
The display name of the material.
Type

string

Read Only

string

Read Only

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.

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

277

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

Definition

string

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

Qualifiers

string

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.
278

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
The material data reference of the duplicated material.

Return

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.
The material property that matches the specified name.

Return

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

279

Engineering Data

IsValid
Validates a material data and provides a message in case of invalid data.
The flag that indicates if the material is valid.

Return

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

Name

The name of the item to delete.

Type

Source

Type

bool

Default Value

True

SetSuppression
Suppresses or Unsuppresses item.

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

281

Engineering Data
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

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

Description
The description of the material property.
Type
282

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

Read Only

string

Read Only

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

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

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

283

Engineering Data
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

Definition

string

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

Qualifiers

string

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 Expansion 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.

284

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

Type
Definition

string

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

SheetQualifiers

string

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.

EndBatchUpdate
Marks the completion of a series of data modifications.

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

285

Engineering Data

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

ColumnMajor

EndIndex

SheetName

bool

Default Value

False

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

The end index for requesting a subset of the data (zero-based).

Type

int

Default Value

-2147483647

Specifies the sheet name when the data contains multiple sheets.
Type

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

StartIndex

Dictionary<string, string>

The start index for requesting a subset of the data (zero-based).

Type

286

string

int

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

Default Value
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

Definition

string

The optional string to specify the material property data definition.

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

287

Engineering Data
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
Qualifiers

string

The optional dictionary of a qualifier name and it's corresponding value.

Dictionary<string, string>

Type

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

Required Arguments
Material

288

The parent material of the property.

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

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 "Variables".
Type

Index

SheetName

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

Specifies the sheet name when the data contains multiple sheets.
Type

SheetQualifiers

Dictionary<string, string>

List of data values set in conjunction with the "Variables" parameter. This parameter
and the "Data" parameter are mutually exclusive.
Type

Variables

string

Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.
Type

Values

Dictionary<string, List<Object>>

List<List<Object>>

Names of the variables for which data is being set. This parameter and and the "Data"
parameter are mutually exclusive.
Type

List<string>

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

289

Engineering Data
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.

Type

Value

290

string

The new value.

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

Type

string

Optional Arguments
SheetName

The name of the tabular data sheet that contains the qualifier.
Type

SheetQualifiers

string

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

VariableName

Dictionary<string, string>

The name of the Variable that contains the qualifier to be changed.

Type

VariableQualifiers

string

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>

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

291

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

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 Instantaneous Coefficient of Thermal Expansion.
Type

string

Read Only

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

string

Read Only

IndependentColl
The collection of independent variables in the material variable tabular data, e.g., Temperature.
Type
292

DataReferenceSet
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

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.
The curve fitting.

Return

Type

DataReference

Required Arguments
Definition

The definition of curve fitting to create. This must be a definition that is supported by an
engineering data curve fitting.
i.e. 1 Parameter, 2 Parameter, 1st Order, 2nd Order
Type

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

293

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

CreateVariable
Include an additional variable in the property data for a material property.
The new variable data that was created.

Return

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.

294

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
DataReference

Type

GetCurveFitting
Query to return the DataReference to the CurveFit used by some PropertyData.
CurveFit DataReference

Return

Type

DataReference

GetVariable
Returns a material variable of a given name from a material property data.
The requested variable.

Return

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

295

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.
bool

Type

IsValid
Validates a material property data and provides a message in case of invalid data.
The flag that indicates if the material property data is valid.

Return

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>

The flag to specify if the item should be suppressed or unsuppressed.

Type

296

bool

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

string

Read Only

IsDependent
The flag that indicates if the material variable is dependent, e.g., Density is temperature dependent.
Type

bool

Read Only

LowerBoundUnit
The unit of the lower bound data value in the material variable data.
Type

string

Read Only

LowerBoundValue
The lower bound data value in the material variable data.
Type

double

Read Only

MaxValue
The maximum value limit of the material variable data.
Type

double

Read Only

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

297

Engineering Data

MinValue
The minimum value limit of the material variable data.
Type

double

Read Only

Offset
The offset value of the material variable data.
Type

Quantity

Read Only

Scale
The scale factor of the material variable data.
Type

double

Read Only

TypeName
The name of the material variable.
Type

string

Read Only

UniqueData
The collection of unique data values in the material variable data.
Type

DataReferenceSet

Read Only

UpperBoundUnit
The unit of the upper bound data value in the material variable data.
Type

string

Read Only

UpperBoundValue
The upper bound data value in the material variable data.
Type

double

Read Only

298

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
The flag that indicates if the material variable is valid.

Return

Type

bool

Required Arguments
Material

The parent material of the variable.

Type

MaterialPropertyData

DataReference

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.GetMaterial(Name="Structural Steel") CTEProp = structSteel.GetProperty(Name="Coefficient of Thermal Expansion") CTEPropData = CTEProperty.GetPropertyData( Name="Coefficient of Thermal Expansion", Definition="Secant", Behavior="Isotropic") CTEVariable = CTEPropData.GetVariable( Name="Coefficient of
Thermal Expansion") valid = EngData.ValidateMaterialVariable(MaterialVariable=CTEVariable, Material=structSteel, MaterialPropertyData=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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

299

Engineering Data
Type

DataReference

Read Only

DependentPropertyColl
The collection of experimental test data, e.g., Uniaxial Test data (Engineering Strain Vs Engineering
Stress).
Type

DataReferenceSet

Read Only

string

Read Only

UnitSystemWhenSolved
The unit system of the coefficients of material model.
Type

string

Read Only

Methods
AddTestData
Adds test data from a given curve fitting.
Required Arguments
TestData

The test data property to add.

Type

DataReference

300

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

301

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

302

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

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.
DataReference

Type

Required Arguments
Name The name of the material. This argument is case insensitive.
Type

string

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

303

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

DisplayName
The display name of the material.
Type

string

Read Only

string

Read Only

304

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

Definition

string

Qualifiers

string

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

305

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.

Return

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.
The material property that matches the specified name.

Return

Type

DataReference

Required Arguments
Name The name of the material property.
Type

string

306

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
The flag that indicates if the material is valid.

Return

Type

Type

bool

Default Value

True

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.

Properties
Behavior
The string that defines the way in which the material property behaves, e.g., Elasticity has Isotropic,
Orthotropic or Anisotropic behavior.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

309

Engineering Data
Type

string

Read Only

string

Read Only

Description
The description of the material property.
Type

string

Read Only

string

Read Only

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

Methods
AddTestData
Includes experimental test data for response function calculations.
Required Arguments
TestData

310

The test data property to add.

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

Type

DataReference

BeginBatchUpdate
Marks the start of a series of data modifications to a table of data, to improve performance.

DataReference

Required Arguments
Name The new material property data name.
Type

string

Optional Arguments
Behavior

Definition

string

Qualifiers

string

The optional dictionary of a qualifier name and it's corresponding value.

Type

Dictionary<string, string>

Create the new material property data.

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

311

#
# 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 Sh
#
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

ColumnMajor

EndIndex

bool

Default Value

False

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

The end index for requesting a subset of the data (zero-based).

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

313

Engineering Data

SheetName

Type

int

Default Value

-2147483647

Specifies the sheet name when the data contains multiple sheets.
Type

SheetQualifiers

string

Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.
Type

StartIndex

Dictionary<string, string>

The start index for requesting a subset of the data (zero-based).

Variables

Type

int

Default Value

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)

314

DataReference

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

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

Definition

string

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

Qualifiers

string

The optional dictionary of a qualifier name and it's corresponding value.

Type

Dictionary<string, string>

IsSuppressed
Checks if an entity is suppressed.
Valid entities are:
Material
Material Property
Material Property Data
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

315

Engineering 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 "Variables".
Type

Index

SheetName

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

Specifies the sheet name when the data contains multiple sheets.
Type

316

Dictionary<string, List<Object>>

string

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

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

Values

Dictionary<string, string>

List of data values set in conjunction with the "Variables" parameter. This parameter
and the "Data" parameter are mutually exclusive.
Type

Variables

List<List<Object>>

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"},
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

317

Engineering Data
Data = newData)

string

Read Only

string

Read Only

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

319

Engineering Data
Type

string

Read Only

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

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

320

The curve fitting.

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

Type

DataReference

Required Arguments
Definition

The definition of curve fitting to create. This must be a definition that is supported by an
engineering data curve fitting.
i.e. 1 Parameter, 2 Parameter, 1st Order, 2nd Order
Type

Type

string

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

CreateVariable
Include an additional variable in the property data for a material property.
The new variable data that was created.

Return

Type

DataReference

Required Arguments
Name The new variable data name.
Type

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

321

Engineering Data
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.
CurveFit DataReference

Return

Type

DataReference

GetVariable
Returns a material variable of a given name from a material property data.
The requested variable.

Return

Type

DataReference

Required Arguments
Name The name of the variable.
Type

string

322

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

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.
The flag that indicates if the material property data is valid.

Return

Type

IgnoreSuppressed

OverwriteTarget

Type

bool

Default Value

False

The flag to specify if suppressed engineering data will be ignored during export.
Type

bool

Default Value

False

The flag to specify if the target file will be overwritten.

ReplaceMaterial

Type

bool

Default Value

False

The flag to specify if the earlier material data will be replaced in case of similar
material names.
Type

bool

Default Value

False

Example
template = GetTemplate(TemplateName="EngData") system = template.CreateSystem(Position="Default")
container = system.GetContainer(ComponentName="Engineering Data") materials = container.GetMaterials() EngData.WriteMaterials(MaterialList=materials, FilePath=r"d:\data\OutputMaterials.xml",
Format="MatML31", UnitSystem="MKS_STANDARD", ReplaceMaterial=true)

DataReference

Required Arguments
Name The name of the material. This argument is case insensitive.
Type

string

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

325

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.
A DataReferenceSet of the materials in the container.

Return

Type

DataReferenceSet

The source which contains the materials.

Type

string

ImportMaterial
Reads the data for a single material into the requested container.
A DataReference for the material that was read.

Return

Type

DataReference

Required Arguments
Name

The name of the material to read from the source.

Type

Source

string

The source which contains the requested material.

Type

string

326

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

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

DisplayName
The display name of the material.
Type

string

Read Only

string

Read Only

Source
The path of the material's source file ("*.engd" or "*.xml").
Type

string

Read Only

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

327

Engineering Data

Methods
AddToFavorites
Adds an item to the Favorites item list.

DataReference

Required Arguments
Name The new material property name.
Type

string

Optional Arguments
Behavior

Definition

string

Qualifiers

string

The optional dictionary of a qualifier name and it's corresponding value.

Type

Dictionary<string, string>

328

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

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.

Return

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.
The material property that matches the specified name.

Return

Type

DataReference

Required Arguments
Name The name of the material property.
Type

string

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

329

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 data and provides a message in case of invalid data.
The flag that indicates if the material is valid.

Return

Type

string

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

Read Only

string

Read Only

Description
The description of the material property.
Type

string

Read Only

string

Read Only

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

Methods
AddTestData
Includes experimental test data for response function calculations.
Required Arguments
TestData

The test data property to add.

Type

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

333

Engineering Data

BeginBatchUpdate
Marks the start of a series of data modifications to a table of data, to improve performance.

DataReference

Required Arguments
Name The new material property data name.
Type

string

Optional Arguments
Behavior

Definition

string

Qualifiers

string

The optional dictionary of a qualifier name and it's corresponding value.

Type

Dictionary<string, string>

Create the new material property data.

orthoSecantThermExpansionMatPropData = thermExpansionMatProp.CreatePropertyData(
Name="Coefficient of Thermal Expansion",

334

Engineering Data

matlProp1 = matl1.GetProperty(Name="Density")
matlProp1.DeleteTabularDataRow(Index = 0)
#
# Delete the first row in the Coefficient of Thermal Expansion property with optional SheeetNamea nd SheetQual
#
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

ColumnMajor

EndIndex

336

bool

Default Value

False

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

The end index for requesting a subset of the data (zero-based).

Type

int

Default Value

-2147483647

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

SheetName

Specifies the sheet name when the data contains multiple sheets.
Type

SheetQualifiers

string

Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.
Type

StartIndex

Dictionary<string, string>

The start index for requesting a subset of the data (zero-based).

Variables

Type

int

Default Value

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)

DataReference

Required Arguments
Name The material property data type name.
Type

string

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

337

Engineering Data
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

Definition

string

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

Qualifiers

string

The optional dictionary of a qualifier name and it's corresponding value.

Type

Dictionary<string, string>

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

338

bool

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

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 "Variables".
Type

Index

SheetName

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

Specifies the sheet name when the data contains multiple sheets.
Type

SheetQualifiers

Dictionary<string, List<Object>>

string

Used to pass in the qualifiers to select between multiple sheets with the same name.
This is a dictionary of qualifiers and values.

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

339

Engineering Data
Type
Values

Dictionary<string, string>

List of data values set in conjunction with the "Variables" parameter. This parameter
and the "Data" parameter are mutually exclusive.
Type

Variables

List<List<Object>>

Names of the variables for which data is being set. This parameter and and the "Data"
parameter are mutually exclusive.
Type

List<string>

340

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

string

Read Only

string

Read Only

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

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

Read Only

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

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

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

343

Engineering Data
Required Arguments
Definition

The definition of curve fitting to create. This must be a definition that is supported by an
engineering data curve fitting.
i.e. 1 Parameter, 2 Parameter, 1st Order, 2nd Order
Type

Type

string

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

CreateVariable
Include an additional variable in the property data for a material property.
The new variable data that was created.

Return

Type

DataReference

Required Arguments
Name The new variable data name.
Type

344

string

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

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.
CurveFit DataReference

Return

Type

DataReference

GetVariable
Returns a material variable of a given name from a material property data.
The requested variable.

Return

Type

DataReference

Required Arguments
Name The name of the variable.
Type

string

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

345

Engineering Data
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.
The flag that indicates if the material property data is valid.

Return

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>

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

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

string

Read Only

IsDependent
The flag that indicates if the material variable is dependent, e.g., Density is temperature dependent.
Type

bool

Read Only

LowerBoundUnit
The unit of the lower bound data value in the material variable data.
Type

string

Read Only

LowerBoundValue
The lower bound data value in the material variable data.
Type

double

Read Only

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

347

Engineering Data

MaxValue
The maximum value limit of the material variable data.
Type

double

Read Only

MinValue
The minimum value limit of the material variable data.
Type

double

Read Only

Offset
The offset value of the material variable data.
Type

Quantity

Read Only

Scale
The scale factor of the material variable data.
Type

double

Read Only

TypeName
The name of the material variable.
Type

string

Read Only

UniqueData
The collection of unique data values in the material variable data.
Type

DataReferenceSet

Read Only

UpperBoundUnit
The unit of the upper bound data value in the material variable data.
Type

string

Read Only

348

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

UpperBoundValue
The upper bound data value in the material variable data.
Type

double

Read Only

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.
The flag that indicates if the material variable is valid.

Return

Type

bool

Required Arguments
Material

The parent material of the variable.

Type

MaterialPropertyData

DataReference

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.GetMaterial(Name="Structural Steel") CTEProp = structSteel.GetProperty(Name="Coefficient of Thermal Expansion") CTEPropData = CTEProperty.GetPropertyData( Name="Coefficient of Thermal Expansion", Definition="Secant", Behavior="Isotropic") CTEVariable = CTEPropData.GetVariable( Name="Coefficient of
Thermal Expansion") valid = EngData.ValidateMaterialVariable(MaterialVariable=CTEVariable, Material=structSteel, MaterialPropertyData=CTEPropdata)

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

349

350

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

string

Type

GetExternalConnectionProperties
A Query to return a reference to the ExternalConnectionProperties entity
A reference to the requested data entity.

Return

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

351

External Connection

Data Entities
ExternalConnectionProperties
This entity holds the properties used to connect a Workbench project to an external process or application.

Properties
ConfigFile
The path to the configuration file defining application settings.
Type

string

Read Only

string

Read Only

WorkingDirectory
The path to the working directory. This is optional. If this value is not set, it defaults to the add-in directory corresponding to the system ("project_files/dpN/sysDir/addinDir")
Type

string

Read Only

352

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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
Returns the reference to the FileData object

Return

Type

DataReference

Required Arguments
FilePath

The data file path

Type

string

AddRepositoryFile
Adds a data file to the outline
Returns the reference to the FileData object

Return

Type

DataReference

Required Arguments
File

The repository file

Type

Index

DataReference

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

353

External Data

GetExternalLoadOutput
Query to return the reference to the container's ExternalDataOutput data entity.
A reference to the requested ExternalLoadData data entity.

Return

Type

DataReference

InsertDataFile
Adds a data file to the outline
Returns the reference to the FileData object

Return

Type

DataReference

Required Arguments
FilePath

The data file path

Type

Index

string

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

RepositoryFile

DataReference

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
354

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

Properties
DataType
DataType of this column data
Type

string

Read Only

string

Read Only

Identifier
Identifier of this column data. This will be used by the down stream applications
Type

string

Read Only

Unit
Unit of this column data
Type

string

Read Only

ExternalLoadData
This is the root level entity for the external data add-in

string

Read Only

FilesData
Cotnains the List of FileData references
Type

List<DataReference>

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

355

External Data
Read Only

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.
A reference to the requested ExternalLoadFileData data entity.

Return

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

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

Type

string

Read Only

File
FileReference maintained by the project
Type

DataReference

Read Only

FileDataProperty
Contains the refernce to the FileDataPoperty
Type

DataReference

Read Only

Master
Makes the Data file as a Master or not. Only one Data file can be a Master.
Type

bool

Read Only

Methods
GetDataProperty
Query to return the reference to the container's ExternalLoadFileDataProperty data entity.
A reference to the requested ExternalLoadFileData data entity.

Return

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

357

External Data
Type

bool

SetDelimiterCharacter
Changes the Delimited Character on the FileDataProperty
Required Arguments
Delimiter

New Delimiter for the FileDataProperty

Type

FileDataProperty

string

FileDataProperty that needs to be modified

Type

DataReference

FormatType

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

LineNumber

DataReference

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

ConversionOption
Contains the option on how to convert the data
Type

VariableConversionOption

Read Only

CoordinateSystemType
Specifies whether to use the Cartesian or Cylindrical coordinate system. The default value is Cartesian
Type

CoordinateSystemType

Read Only

DelimiterCharacter
Contains the delimiter character. Based on this value, number of columns are calculated
Type

string

Read Only

DelimiterType
Contains either the predefined delimiter or the user defined delimiter type

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

359

External Data
Type

DelimiterType

Read Only

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

string

Read Only

FileIdentifier
A string that can be used to identify the file in the downstream Mechanical application. The data identifiers, 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

FormatString
Contains the FormatString. Based on this value, number of columns are calculated
Type

string

Read Only

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

LengthUnit
The units of measurement to be used.
Type

string

Read Only

360

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

OriginX
Contains the OriginX value
Type

double

Read Only

OriginXUnit
Contains the unit of the OriginX
Type

string

Read Only

OriginY
Contains the OriginY value
Type

double

Read Only

OriginYUnit
Contains the unit of the OriginY
Type

string

Read Only

OriginZ
Contains the OriginZ value
Type

double

Read Only

OriginZUnit
Contains the unit of the OriginZ
Type

string

Read Only

ScaleX
Contains the Scale X string
Type

string

Read Only

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

361

External Data

ScaleXToolTip
Contains the tool tip of the Scale X
Type

string

Read Only

ScaleXValid
Contains the whether the Scale X string is valid or not
Type

bool

Read Only

ScaleY
Contains the Scale Y string
Type

string

Read Only

ScaleYToolTip
Contains the tool tip of the Scale Y
Type

string

Read Only

ScaleYValid
Contains the whether the Scale Y string is valid or not
Type

bool

Read Only

ScaleZ
Contains the Scale Z string
Type

string

Read Only

ScaleZToolTip
Contains the tool tip of the Scale Z
Type

string

Read Only

362

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

ScaleZValid
Contains the whether the Scale Z string is valid or not
Type

bool

Read Only

StartImportAtLine
The line number at which you want the data import to start. Line numbers start at 1.
Type

int

Read Only

ThetaXY
Contains the ThetaXY value
Type

double

Read Only

ThetaXYUnit
Contains the unit of the ThetaXY
Type

string

Read Only

ThetaYZ
Contains the ThetaYZ value
Type

double

Read Only

ThetaYZUnit
Contains the unit of the ThetaYZ
Type

string

Read Only

ThetaZX
Contains the ThetaZX value
Type

double

Read Only

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

363

External Data

ThetaZXUnit
Contains the unit of the ThetaZX
Type

string

Read Only

Methods
GetColumnData
Query to return the reference to the container's ExternalLoaColumndData data entity.
A reference to the requested ExternalLoadFileData data entity.

Return

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

DataType

DataReference

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

364

Coordinate X,Y,Z

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

Type
Unit

string

New Length Unit for the FileDataProperty

Type

string

SetDimensionType
Changes the DimensionsType on the FileDataProperty
Required Arguments
Dimensions

New DimensionsType for the FileDataProperty

Type

Type

string

AddRepositoryFile
Adds a data file to the outline
Returns the reference to the FileData object

Return

Type

DataReference

Required Arguments
File

The repository file

Type

Index

DataReference

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

367

External Model Setup

GetExternalModelOutput
Query to return the reference to the container's ExternalDataOutput data entity.
A reference to the requested ExternalLoadData data entity.

Return

Type

DataReference

InsertDataFile
Adds a data file to the outline
Returns the reference to the FileData object

Return

Type

DataReference

Required Arguments
FilePath

The data file path

Type

Index

string

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

RepositoryFile

DataReference

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
368

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

string

Read Only

FilesData
Cotnains the List of FileData references
Type

List<DataReference>

Read Only

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.
A reference to the requested ExternalLoadFileData data entity.

Return

Type

DataReference

Required Arguments
Name Name of the ExternalModelFileData entity
Type

string

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

369

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

string

Read Only

File
FileReference maintained by the project
Type

DataReference

Read Only

FileDataProperty
Contains the refernce to the FileDataPoperty
Type

DataReference

Read Only

Methods
GetDataProperty
Query to return the reference to the container's ExternalLoadFileDataProperty data entity.
A reference to the requested ExternalLoadFileData data entity.

Return

Type

DataReference

ModifyFileData
Changes the file path of the existing FileData
Required Arguments
FilePath
370

FilePath to be modified in the FileData

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

Type

string

ExternalModelFileDataProperty
Contains information displayed on the properties view

string

Read Only

LengthUnit
The units of measurement to be used.
Type

string

Read Only

NumberOfCopies
Number of copies to be created by downstream consumer
Type

int

Read Only

OriginX
Contains the OriginX value
Type

double

Read Only

OriginXUnit
Contains the unit of the OriginX
Type

string

Read Only

OriginY
Contains the OriginY value
Type

double

Read Only

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

371

External Model Setup

OriginYUnit
Contains the unit of the OriginY
Type

string

Read Only

OriginZ
Contains the OriginZ value
Type

double

Read Only

OriginZUnit
Contains the unit of the OriginZ
Type

string

Read Only

ThetaXY
Contains the ThetaXY value
Type

double

Read Only

ThetaXYUnit
Contains the unit of the ThetaXY
Type

string

Read Only

ThetaYZ
Contains the ThetaYZ value
Type

double

Read Only

ThetaYZUnit
Contains the unit of the ThetaYZ
Type

string

Read Only

372

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

ThetaZX
Contains the ThetaZX value
Type

double

Read Only

ThetaZXUnit
Contains the unit of the ThetaZX
Type

string

Read Only

TransformOriginal
Whether or not we are going to transform the first instance of the model
Type

bool

Read Only

Methods
SetLengthUnit
Changes the Length Unit on the FileDataProperty
Required Arguments
Unit

New Length Unit for the FileDataProperty

Type

string

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

373

Return

Type

DataReference

Required Arguments
Name Name of the entity
Type

string

GetFEMModel
Returns the reference of the container's FEMModel data entity.
The reference of the FEMModel data entity

Return

Type

DataReference

Required Arguments
Name Name of the entity
Type

string

GetFEMSetup
Returns the reference of the container's FEMSetup data entity.
The reference of the FEMSetup data entity

Return

Type

DataReference

Required Arguments
Name Name of the entity
Type
376

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

GetGeometry
Returns the reference of the container's FEMGeometry data entity.
The reference of the FEMGeometry data entity

Return

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
Command

Command argument containing the command.

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 'UpstreamInputMeshObject'. 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

string

Read Only

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

377

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

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

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

378

DataReference

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 retrieved 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

string

Read Only

FEMModel
This object represents the Assembly Mesh as well as the main storage location for some internal data
for the container.

string

Read Only

GeometryImportAnalysisType
Analysis Type preference. Import 3D objects or 2D objects (objects must be in the x-y plane)
Type

GeometryAnalysisType

Read Only

InputMeshes
The list of all input meshes for the current model.
Type

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

379

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

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

string

Read Only

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

380

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

string

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

381

Finite Element Modeler

Read Only

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

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

string

Read Only

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

382

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

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

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

string

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

383

384

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 systems 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

FileType

DataReference

Reference to Fluent's File type

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

385

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

string

Read Only

LineWidth
Line width of the curve represnting this variable entity.
Type

float

Read Only

QuantityName
The variable quantity to display.
Type

386

string

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

Read Only

SymbolSize
Symbol size of the points on the curve.
Type

uint

Read Only

Methods
DeleteChartVariable
Deletes a specified chart variable.

ConvergenceChart
Entity to store a convergence chart information.

Properties
AxisX
Associated X Axis
Type

DataReference

Read Only

AxisY
Associated Y Axis
Type

DataReference

Read Only

ChartType
MonitorChartType: Residual or UserDefined
Type

MonitorChartType

Read Only

string

Read Only

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

387

FLUENT

Variables
Collection of variables to be plotted.
Type

DataReferenceSet

Read Only

XAxis
Label for the x-axis/Horizontal Axis.
Type

string

Read Only

Methods
GetAxis
Returns the axis for a specified convergence chart
The axis

Return

Type

DataReference

Required Arguments
Name Name of the Axis
Type

string

GetChartVariable
Returns the chart variable of a given name from a convergence chart
The chart variable that matches the specified name.

Return

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

388

DataReferenceSet

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

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

ClusterHeadNode
Specify the name of the compute cluster head node.
This property is only available on Windows.
Type

string

Read Only

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

ClusterNodeGroup
Used to set specific node group(s) on which to run the job. Relevant for Microsoft Job Scheduler.
Type

string

Read Only

ClusterProcessorUnit
Select the unit type (node/socket/core) on which the job would be running. Relevant for Microsoft Job
Scheduler.
Type

ProcessorUnit

Read Only

ConvertUNCPath
Specify whether or not to convert a local path to a UNC path if any matching shared directory is found.
Type

bool

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

389

FLUENT
Read Only

CreateJobSubmissionXML
Specify whether or not to create the job submission XML file.
This property is only available on Windows.
Type

bool

Read Only

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

string

Read Only

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

EnvPath
Specify the list of environment variables to set before starting FLUENT.
Type

Dictionary<string, string>

Read Only

Initialization
Specify which initialization method to use.
Type

InitializationMethods

Read Only

390

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

InitSolutionDataFile
Spepcify the solution data file to be used for initializing the solution.
Type

string

Read Only

Interconnect
Specify the interconnect that you wish to use for parallel calculations
(e.g., ethernet, myrinet, infniband, etc.).
Type

string

Read Only

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

JobSubmissionXmlFile
Specify the name of the job submission XML file.
This property is only available on Windows.
Type

string

Read Only

LSFCheckpointPeriod
Specify the interval of automatic checkpointing for LSF.
This property is only available when using compute nodes on Linux.
Type

int

Read Only

LSFQueue
Specify the name of the LSF queue.
This property is only available when using compute nodes on Linux.
Type

string

Read Only

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

391

FLUENT

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

MachineFileName
Specify the name of the file that contains a list of machine names to run the parallel job.
Type

string

Read Only

MachineList
Specify a list of machine names to run the parallel job.
Type

string

Read Only

MachineSpec
Specify a list of machine names, or a file that contains machine names.
Type

MachineSpecification

Read Only

MpiType
Specify the MPI type that you wish to use for the parallel calculations
(e.g., MPICH2, HP, etc.).
Type

string

Read Only

NumberOfProcessors
Specify the number of processors you wish to use for the parallel calculations (e.g., 2, 4, etc.).
Type

int

Read Only

NumberOfProcessorsMeshing
Specify the number of processors you wish to use for the meshing parallel calculations (e.g., 2, 4, etc.).

392

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

Type

int

Read Only

Precision
Specify whether to use the single-precision or the double-precision solver.
Type

CasePrecision

Read Only

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

RemoteFluentRootPath
Specify the root path of the remote FLUENT Linux installation.
This property is only available on Windows.
Type

string

Read Only

RemoteHostName
Specify the name of the head machine on the remote Linux cluster.
This property is only available on Windows.
Type

string

Read Only

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

RemoteRshOtherCommand
Specify the custom RSH spawn command used to connect to the remote Linux machine.
This property is only available on Windows.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

393

FLUENT
Type

string

Read Only

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

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

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

RemoteWorkingDirectory
Specify the name of the working directory for remote Linux nodes.
This property is only available on Windows.
Type

string

Read Only

RunParallel
Specify whether or not you want to run the parallel version of FLUENT.
Type

bool

Read Only

394

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

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

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

SGEQMaster
Specify the name of the Qmaster host.
This property is only available when using compute nodes on Linux.
Type

string

Read Only

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

SGESettings
Specify SGE Settings to be used
This property is only available when using compute nodes on Linux.
Type

string

Read Only

SGEUseSettings
Specify whether or not to use the specified SGE Settings.
Use the SGESettings property to specify the SGE Settings.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

395

FLUENT
This property is only available when using compute nodes on Linux.
Type

bool

Read Only

ShowLauncher
Specify whether or not to show FLUENT Launcher when FLUENT starts.
Type

bool

Read Only

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

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

UseJobScheduler
Specify whether or not to use a job scheduler to run FLUENT jobs.
Type

bool

Read Only

UseLSFCheckpoint
Specify whether or not to use LSF checkpointing.
This property is only available when using compute nodes on Linux.
Type

bool

Read Only

UseLSFQueue
Specify whether or not to use the LSF queue.
This property is only available when using compute nodes on Linux.
396

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

Type

bool

Read Only

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

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

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

SetupData
Data entity of Setup cell. Allows you to change attributes of Setup cell.

string

Read Only

GenerateSetupOutput
Allows you to generate case file for Setup cell if mesh file is input or mesh operations are defined
Type

bool

Read Only

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

397

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.

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.
The convergence chart that matches the specified name.

Return

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.

398

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

Collection of the convergence charts in the container.

Return

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.

>> setup1.SendCommand(Command="/file/read-journal \"E:\\WB Projects\\Fluent Case-Data Files\elbow.jou\"

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

399

FLUENT

Data Entities
AxisContinuous
Data entity for Scenegraph axis.

Properties
AutomaticRange
Boolean var for Automatic Range
Type

bool

Read Only

string

Read Only

QuantityName
Name of the quantity being plotted at this axis
Type

XAxisQuantity

Read Only

RangeMaximum
Max value of quantity at this axis
Type

double

Read Only

RangeMinimum
Min value of quantity at this axis
Type

double

Read Only

Scale
Scale of this axis
Type

Scale

Read Only

400

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

Title
Title of the axis
Type

string

Read Only

ChartVariable
Entity representing a variable in Convergence Chart

Properties
Color
Color of the curve represnting this variable entity.
Type

Color

Read Only

string

Read Only

LineWidth
Line width of the curve represnting this variable entity.
Type

float

Read Only

QuantityName
The variable quantity to display.
Type

string

Read Only

SymbolSize
Symbol size of the points on the curve.
Type

uint

Read Only

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

401

FLUENT

Methods
DeleteChartVariable
Deletes a specified chart variable.

ChartVariableData
Entity representing a variable in Convergence Chart

string

Read Only

VariableDimension
Dimentions in string format
Type

string

Read Only

VariableIndex
A integer: variable index of given MonitorChartType
Type

int

Read Only

VariableType
MonitorChartType: Residual or UserDefined, an enum
Type

MonitorChartType

Read Only

ConvergenceChart
Entity to store a convergence chart information.

Properties
AxisX
Associated X Axis

402

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

Type

DataReference

Read Only

AxisY
Associated Y Axis
Type

DataReference

Read Only

ChartType
MonitorChartType: Residual or UserDefined
Type

MonitorChartType

Read Only

string

Read Only

Variables
Collection of variables to be plotted.
Type

DataReferenceSet

Read Only

XAxis
Label for the x-axis/Horizontal Axis.
Type

string

Read Only

Methods
GetAxis
Returns the axis for a specified convergence chart
Return

The axis
Type

DataReference

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

403

FLUENT
Required Arguments
Name Name of the Axis
Type

string

GetChartVariable
Returns the chart variable of a given name from a convergence chart
The chart variable that matches the specified name.

Return

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
A collection of the variables in the chart.

Return

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

ClusterHeadNode
Specify the name of the compute cluster head node.
This property is only available on Windows.
Type

string

Read Only

404

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

Type

string

Read Only

ClusterNodeGroup
Used to set specific node group(s) on which to run the job. Relevant for Microsoft Job Scheduler.
Type

string

Read Only

ClusterProcessorUnit
Select the unit type (node/socket/core) on which the job would be running. Relevant for Microsoft Job
Scheduler.
Type

ProcessorUnit

Read Only

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

CreateJobSubmissionXML
Specify whether or not to create the job submission XML file.
This property is only available on Windows.
Type

bool

Read Only

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

string

Read Only

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

405

FLUENT

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

EnvPath
Specify the list of environment variables to set before starting FLUENT.
Type

Dictionary<string, string>

Read Only

Initialization
Specify which initialization method to use.
Type

InitializationMethods

Read Only

InitSolutionDataFile
Spepcify the solution data file to be used for initializing the solution.
Type

string

Read Only

Interconnect
Specify the interconnect that you wish to use for parallel calculations
(e.g., ethernet, myrinet, infniband, etc.).
Type

string

Read Only

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

JobSubmissionXmlFile
Specify the name of the job submission XML file.

406

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

This property is only available on Windows.

Type

string

Read Only

LSFCheckpointPeriod
Specify the interval of automatic checkpointing for LSF.
This property is only available when using compute nodes on Linux.
Type

int

Read Only

LSFQueue
Specify the name of the LSF queue.
This property is only available when using compute nodes on Linux.
Type

string

Read Only

bool

Read Only

MachineFileName
Specify the name of the file that contains a list of machine names to run the parallel job.
Type

string

Read Only

MachineList
Specify a list of machine names to run the parallel job.
Type

string

Read Only

MachineSpec
Specify a list of machine names, or a file that contains machine names.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

407

FLUENT
Type

MachineSpecification

Read Only

MpiType
Specify the MPI type that you wish to use for the parallel calculations
(e.g., MPICH2, HP, etc.).
Type

string

Read Only

NumberOfProcessors
Specify the number of processors you wish to use for the parallel calculations (e.g., 2, 4, etc.).
Type

int

Read Only

NumberOfProcessorsMeshing
Specify the number of processors you wish to use for the meshing parallel calculations (e.g., 2, 4, etc.).
Type

int

Read Only

Precision
Specify whether to use the single-precision or the double-precision solver.
Type

CasePrecision

Read Only

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

RemoteFluentRootPath
Specify the root path of the remote FLUENT Linux installation.
This property is only available on Windows.
Type

string

Read Only

408

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

RemoteHostName
Specify the name of the head machine on the remote Linux cluster.
This property is only available on Windows.
Type

string

Read Only

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

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

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

bool

Read Only

RemoteUseWorkingDirectory
Specify whether or not to use a working directory for remote Linux nodes.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

409

FLUENT
Use the RemoteWorkingDirectory property to specify the name of the working directory.
This property is only available on Windows.
Type

bool

Read Only

RemoteWorkingDirectory
Specify the name of the working directory for remote Linux nodes.
This property is only available on Windows.
Type

string

Read Only

RunParallel
Specify whether or not you want to run the parallel version of FLUENT.
Type

bool

Read Only

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

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

SGEQMaster
Specify the name of the Qmaster host.
This property is only available when using compute nodes on Linux.
Type

string

Read Only

410

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

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

SGESettings
Specify SGE Settings to be used
This property is only available when using compute nodes on Linux.
Type

string

Read Only

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

ShowLauncher
Specify whether or not to show FLUENT Launcher when FLUENT starts.
Type

bool

Read Only

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

UDFPath
Specify the path to the UDF compilation script (available when SetupCompilationEnvironment is TRUE).
This property is only available on Windows.
Type

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

411

FLUENT
Read Only

UseJobScheduler
Specify whether or not to use a job scheduler to run FLUENT jobs.
Type

bool

Read Only

UseLSFCheckpoint
Specify whether or not to use LSF checkpointing.
This property is only available when using compute nodes on Linux.
Type

bool

Read Only

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

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

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

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

412

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

FluentSolutionProperties
Entity that manages settings and data for the FLUENT Solution component.

string

Read Only

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

EnableSolutionMonitoring
It allows to generate the solution monitoring data which can be viewed using commands at Solution
cell.
Type

bool

Read Only

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

413

414

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 Interactive mode or batch mode. Its default
value is True

Optional Arguments
Interactive

Whether to edit in batch mode

IsSpaceClaimGeometry

Type

bool

Default Value

True

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

415

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 filename 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 invalid characters
When DesignModeler is busy.

ApplicationBusyException
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.
Reference to DataEntity managing geometry properties

Return

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 DesignModeler.
After succesful execution of this command, the geometry component goes into "update required" state.
Optional Arguments
RepositoryFilesToRefresh

Registered Repository files

Type

416

List<DataReference>

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

SendCommand
The SendCommand sends javascript command string to DesignModeler for execution. If DesignModeler
is not open, it will be launched to execute javascript commands, and then closed. If DesignModler is
already running, it will keep running after the command execution.
If DesignModeler is busy and not available for executing the javascript instruction, the SendCommand
throws an ApplicationBusyException exception.
Available options:
Command

Javascript command string containing scripting commands for DesignModeler

The following command will add a sketch with an elliptical curve in DesignModeler
Required Arguments
Command

Javascript command string

Type

string

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
PlugInName

Path of the geometry file

PlugIn Name, in case of PlugIn mode geometry transfer

Required Arguments
FilePath

Path of the Geometry File

Type

string

Optional Arguments
CreatedFileRef

Created File reference

Type

Output<DataReference>

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

417

Geometry
PlugInName

PlugIn Name, in case of PlugIn mode Geometry transfer

Type

RepositoryFileReference

string

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

QuantityValue

string

Double value of the Quantity to update

Type

double

Data Entities
Geometry
Geometry data object

418

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

string

Read Only

GeometryFilePath
The location of file currently assigned to geometry component. DesignModeler process this file when
started through Edit command.
Type

string

Read Only

GeometryImportAnalysisType
Analysis Type preference. Import 3D objects or 2D objects (objects must be in the x-y plane)
Type

AnalysisType

Read Only

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

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

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

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

419

Geometry

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

GeometryImportComparePartsTolerance
Compare Parts Tolerance Preference. Sets one of three tolerance values for comparison when running
Compare Parts On Update
Type

ComparePartsTolerance

Read Only

GeometryImportCoordinateSystems
Import Coordinate Systems preference. Specifies whether coordinate systems created in the CAD application should be imported into the Mechanical application.
Type

bool

Read Only

GeometryImportDecomposeDisjointFaces
Decompose Disjoint Face preference. Use to turn on/off the breaking of disjoint faces into multiple
faces.
Type

bool

Read Only

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

GeometryImportLineBodies
Import Line Bodies preference. (If mixed dimension parts, Mixed Import Resolution preference is used.)
Type

bool

Read Only

420

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

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

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

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

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

GeometryImportParameters
Import Parameters preference. Allows user to turn on or off parameter processing.
Type

bool

Read Only

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
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

421

Geometry

GeometryImportProcessEnclosures
Enclosure and Symmetry preference. Use to turn on/off the processing of enclosure and symmetry
named selections.
Type

bool

Read Only

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

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

GeometryImportSolidBodies
Import Solid Bodies preference. (If mixed dimension parts, Mixed Import Resolution preference is used.)
Type

bool

Read Only

GeometryImportSTLAngleAlgorithmCutAngle
Cut Angle parameter for the Angle Algorithm
Type

double

Read Only

GeometryImportSTLAngleAlgorithmToleranceAngle
Tolerance Angle parameter for the Angle Algorithm
Type

double

Read Only

GeometryImportSTLCurvatureAlgorithmIgnoreSecondaryNodes
Ignore secondary nodes parameter for the Curvature Algorithm

422

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

Type

bool

Read Only

GeometryImportSTLCurvatureAlgorithmPlanesToleranceAngle
Planes tolerance parameter for the Curvature Algorithm
Type

double

Read Only

GeometryImportSTLCurvatureAlgorithmSharpEdgesAngle
Sharp edges angle parameter for the Curvature Algorithm
Type

double

Read Only

GeometryImportSTLSDTAlgorithm
Analysis Type preference. Import 3D objects or 2D objects (objects must be in the x-y plane)
Type

STLSDTAlgorithm

Read Only

GeometryImportSurfaceBodies
Import Surface Bodies preference. (If mixed dimension parts, Mixed Import Resolution preference is
used.)
Type

bool

Read Only

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

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

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

423

Geometry

TeamcenterConnection
The source string obtained from the Teamcenter, pointing to the NX geometry.
Type

string

Read Only

424

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

Label
The label of the axis.
Type

string

Read Only

Logarithmic
This property controls whether the axis scaling is to be logarithmic or linear. The default is linear scaling.
Type

bool

Read Only

RangeMax
The maximum range of the values in this axis.
Type

double

Read Only

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

425

Graphics

RangeMin
The minimum range of the values in this axis.
Type

double

Read Only

ShowGrid
Defines whether or not to show a grid for this chart axis.
Type

bool

Read Only

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

Usability
Determine whether this axis represents a usability axis. A usability axis presents discrete allowable values
rather than continuous values.
Type

bool

Read Only

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

Label
The label of the axis.
Type

string

Read Only

426

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

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

ShowGrid
Defines whether or not to show a grid for this chart axis.
Type

bool

Read Only

Color

Read Only

ChartXY
This entity provides general properties for an XY (i.e. two dimensional) chart. Plotting details are determined from the associated variables and axes.

Properties
Legend
Reference to the Legend entity that is applied to the chart.
Type

DataReference

Read Only

Style
Reference to the RenderStyle entity that is applied to the chart.
Type

DataReference

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

427

Graphics
Read Only

Title
The title of the chart.
Type

string

Read Only

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

XAxis
The data reference to the x-axis.
Type

DataReference

Read Only

XAxisSecondary
The data reference to the secondary x-axis.
Type

DataReference

Read Only

YAxis
The data reference to the y-axis.
Type

DataReference

Read Only

YAxisSecondary
The data reference to the secondary y-axis.
Type

DataReference

Read Only

ChartXYZ
This chart is a canvas for an XYZ plot, the manor of plotting will be determined by the specified variables.

428

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

Style
Reference to the RenderStyle entity that is applied to the chart.
Type

DataReference

Read Only

Title
The title of the chart.
Type

string

Read Only

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

XAxis
The data reference to the X-Axis.
Type

DataReference

Read Only

YAxis
The data reference to the Y-Axis.
Type

DataReference

Read Only

ZAxis
The data reference to the Y-Axis.
Type

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

429

Graphics
Read Only

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

Legend
Reference to the Legend entity that is applied to the chart.
Type

DataReference

Read Only

Style
Reference to the RenderStyle entity that is applied to the chart.
Type

DataReference

Read Only

Title
The title of the chart.
Type

string

Read Only

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

Legend
This entity provides a legend for chart data.

430

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

Properties
BackgroundColor
The background color of the legend.
Type

Color

Read Only

string

Read Only

Enabled
This property will enable or disable the legend.
Type

bool

Read Only

ForegroundColor
The foreground (border) color of the legend.
Type

Color

Read Only

Orientation
This property defines the orientation of the legend.
Type

OrientationStyle

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

431

Graphics
Read Only

Legend
Reference to the Legend entity that is applied to the chart.
Type

DataReference

Read Only

Style
Reference to the RenderStyle entity that is applied to the chart.
Type

DataReference

Read Only

Title
The title of the chart.
Type

string

Read Only

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

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

Legend
Reference to the Legend entity that is applied to the chart.
Type

432

DataReference

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

Read Only

ShowPercentages
Should the percentages for the slices be shown.
Type

bool

Read Only

Style
Reference to the RenderStyle entity that is applied to the chart.
Type

DataReference

Read Only

Title
The title of the chart.
Type

string

Read Only

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

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

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

433

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

string

Read Only

DotStyle
The symbol to be used to at each plot point.
Type

DotStyles

Read Only

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

FillStyle
The shading to be used for any filled region.
Type

FillStyles

Read Only

GradientAxis
The axis that defines plot color if gradient shading is enabled. The axis must be continuous.
Type

Axis

Read Only

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.

434

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

Type

List<Color>

Read Only

LineStyle
The style of the line.
Type

LineStyles

Read Only

LineWidth
Sets the width of the line drawn for this variable in pixels.
Type

uint

Read Only

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

OutlineColors
Define the outline colors for symbols. If not set (the default) then LineColors is used.
Type

List<Color>

Read Only

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

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

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

435

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

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

BoundsMax
Defines the maximum rendered value for the data. Any larger values will be ignored.
Type

float

Read Only

BoundsMin
Defines the minimum rendered value for the data. Any smaller values will be ignored.
Type

float

Read Only

DisplayAs
Controls if this variable is displayed using lines, bars, etc.
Type

VariableStyle

Read Only

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
436

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

Read Only

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

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

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

Label
The label of the variable. This is optional and is typically determined from the name of the input variable.
Type

string

Read Only

RelativeOrder
Define the order of this variable among all the variables in a chart.
Type

int

Read Only

VariableXY
This is the base class for a data entity that defines a variable to be plotted.

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

437

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

BoundsMax
Defines the maximum rendered value for the data. Any larger values will be ignored.
Type

float

Read Only

BoundsMin
Defines the minimum rendered value for the data. Any smaller values will be ignored.
Type

float

Read Only

DisplayAs
Controls if this variable is displayed using lines, bars, etc.
Type

VariableStyle

Read Only

float

Read Only

float

Read Only

438

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

bool

Read Only

Label
The label of the variable. This is optional and is typically determined from the name of the input variable.
Type

string

Read Only

RelativeOrder
Define the order of this variable among all the variables in a chart.
Type

int

Read Only

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

BoundsMax
Defines the maximum rendered value for the data. Any larger values will be ignored.
Type

float

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

439

Graphics
Read Only

BoundsMin
Defines the minimum rendered value for the data. Any smaller values will be ignored.
Type

float

Read Only

DisplayAs
Controls if this variable is displayed using lines, bars, etc.
Type

VariableStyle

Read Only

float

Read Only

float

Read Only

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

bool

Read Only

440

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

RelativeOrder
Define the order of this variable among all the variables in a chart.
Type

int

Read Only

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

441

442

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

CRLength
User input: Connecting Rod Length
Type

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

443

ICE
Read Only

string

Read Only

EngineSpeed
User input: Engine Speed
Type

Quantity

Read Only

EVO
User input: Engine Speed
Type

Quantity

Read Only

ICCombustionSimulationType
User input: IC Engine Combustion Simulation Type
Type

ICCombustionSimulationType

Read Only

ICIVCandEVOOption
User input: Option to get IVC and EVO values
Type

ICIVCandEVOoption

Read Only

ICSimulationType
User input: IC Engine Simulation Type
Type

ICSimulationType

Read Only

IVC
User input: Engine Speed
Type

444

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

Read Only

LiftCurvePath
User input: Path to the valve lift curve
Type

string

Read Only

MinLift
User input: Mimimum Lift
Type

Quantity

Read Only

PistonOffset
User input: Piston Offset
Type

Quantity

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

445

ICE

Data Entities
ICESetupData
ICE Setup Data Object

Properties
CrankAngleSelector
This is link for crank angle selection or KeyGrid dialog.
Type

string

Read Only

string

Read Only

ICKeyGridOption
Yes/No option for key grid
Type

Read Only

PostIterationJournal
User input: Path to post iteration journal file
Type

string

Read Only

PreIterationJournal
User input: Path to Pre Iteration Journal File
Type

string

Read Only

SolverSettingEditor
This is link for solver setting dialog.
Type

string

Read Only

446

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

UserBCProfileFile
User input: Path to User Boundary Condition Profiles
Type

string

Read Only

UserSettingsFilePath
User input: Path to User Boundary Conditions and Monitor Path
Type

string

Read Only

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

447

448

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.

string

Read Only

Subsets
ICEM CFD creates Subsets instead of Parts from Named Selections if set.
Type

bool

Read Only

TransferFile
The ICEM CFD downstream files are *.msh "Imported FLUENT Mesh File Type", *.poly "POLYFLOWMesh",
and *.inp "ANSYS Input File".
Type

DataReference

Read Only

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

449

450

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

SystemCoordinate

Type

bool

Default Value

True

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 processing.By default, the case and data files from the latest solution are available on the solution component.
Required Arguments
FilePath

Path to the project or tzr file when operated on Setup container. Path to the case file to be
imported when operated on the Solution container
Type

string

Example
When the Import is called on the Setup container
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

451

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

string

Read Only

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

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

452

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 processing.By default, the case and data files from the latest solution are available on the solution component.
Required Arguments
FilePath

Path to the project or tzr file when operated on Setup container. Path to the case file to be
imported 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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

453

454

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

455

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.

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

string

Read Only

LimitOnNumberOfCores
The number of processes that the RSM-based design point update should not exceed during execution.
Type

int

Read Only

SerialOnly
Indicates whether or not to execute only serially.
Type

bool

Read Only

456

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

UseLimitOnNumberOfCores
Indicates whether to limit the number of processes for parallel execution.
Type

bool

Read Only

MapdlInputFile
Represents an input file for the Mechanical APDL editor.

string

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

457

Mechanical APDL

string

Read Only

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

CustomExecutablePath
Calls a custom ANSYS executable.
Type

string

Read Only

DatabaseMemory
Defines the portion of workspace (memory) to be used for the database. The default is 512 MB for 64bit machines, 256 MB for 32-bit machines.
Type

int

Read Only

458

string

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

Read Only

Distributed
Enables Distributed ANSYS.
Type

bool

Read Only

DownloadDistributedFiles
Indicates whether or not to download files from slave node scratches during distributed solves
Type

bool

Read Only

GPUAccelerator
Specifies the type of GPU Accelerators. By default this is set to none meaning no GPU acceleration is
used.
Type

GPUAccelerator

Read Only

Graphics
Specifies the type of graphics device. This option applies only to interactive mode. For UNIX/Linux systems, graphics device choices are X11, X11C, or 3D. For Windows systems, graphics device options are
WIN32 or WIN32C, or 3D.
Type

string

Read Only

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

License
Defines which ANSYS product will run during the session (ANSYS Multiphysics, ANSYS Structural, etc.).
Type

string

Read Only

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

459

Mechanical APDL

MachineList
Specifies the machines on which to run a Distributed ANSYS analysis.
Type

string

Read Only

MPIType
Defines which type of MPI the solver should use.
Type

MPIType

Read Only

NumberOfGpusPerMachine
Specifies the number of accelerators to use when running with GPU Acceleration.
Type

int

Read Only

Processors
Specifies the number of processors to use when running Distributed ANSYS or Shared-memory ANSYS.
Type

int

Read Only

ReadStartAns
Specifies whether the program reads the start121.ans file at start-up.
Type

bool

Read Only

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

460

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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
Interactive

Specify if Mechanical will open in interactive mode. The default value is true.
Type

bool

Default Value

True

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
Optional Arguments
SaveDatabase

Indicates whether the Mechanical database will be saved prior to exiting

Type

bool

Default Value

True

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

461

Mechanical

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.

Interactive

Type

bool

Default Value

False

Specify if Mechanical will open in interactive mode. The default value is true.
Type

bool

Default Value

True

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
Optional Arguments
SaveDatabase

Indicates whether the Mechanical database will be saved prior to exiting

Type

bool

DataReference

GetSimulationImportOptions
Query to return the data reference to the simulation import options
The Data Entity containing settings for this component.

Return

Type

DataReference

Required Arguments
Name The entity of interest.
Type

string

SendCommand
Executes a JScript 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 SendCommand.
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
Command

Command argument containing the command.

Type

string

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\")")

464

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

Data Entities
CDBImportSettingsEntity
(Beta) Entity to control the Skin Detection algorithm for importing cdb files.

Properties
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

string

Read Only

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

GeometryImportAnalysisType
The geometry attach type for the CDB file
Type

GeometryAttachType

Read Only

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

Read Only

ProcessNodalComponents
Should the nodal components be processed during CDB conversion
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

465

Mechanical
Type

bool

Read Only

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

GeneralModelAssemblyProperties
Class used to expose general properties for the model assembly workflow

string

Read Only

LengthUnit
Length unit of assembled model
Type

string

Read Only

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

466

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

Type

string

Read Only

MeshId
Mesh identifier that corresponds with Mesh ID in Mechanical
Type

int

Read Only

MechanicalModel
The model data entity in the model container.

Properties
AllowMeshing
Property used to prevent a re meshing in model assembly workflows
Type

bool

Read Only

Caption
Caption to identify the model
Type

string

Read Only

string

Read Only

EdaFile
Reference to a material database
Type

DataReference

Read Only

File
Reference to the Mechanical database
Type

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

467

Mechanical
Read Only

IsResetNotRequired
Property used to prevent cascasding resets on downstream containers
Type

bool

Read Only

ModelId
Model identifier that corresponds with the ID on Model tree node in Mechanical
Type

int

Read Only

PrototypeId
Prototype identifier which corresponds to the ID on the Geometry tree node in Mechanical
Type

int

Read Only

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

string

Read Only

PhysicsTypeDisplayString
The string which represents current physics type setting.
Type

468

string

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

Read Only

Yes

SolverTypeDisplayString
The string which represents current solver type setting.
Type

string

Read Only

Yes

ModelOutputSettingsForACP
Entity to control the properties of mesh file generated by Mechanical Model.

string

Read Only

LengthUnit
Length unit to write mesh file.
Type

string

Read Only

SimulationImportOptions
Import options for model assembly available on the downstream model

string

Read Only

NumberOfCopies
By default this value is 0, specifies how many additional copies of the upstream model are needed
Type

int

Read Only

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

469

Mechanical

OriginX
Displacement along the X axis
Type

Quantity

Read Only

OriginY
Displacement along the Y axis
Type

Quantity

Read Only

OriginZ
Displacement along the Z axis
Type

Quantity

Read Only

Source
The upstream model source
Type

DataReference

Read Only

ThetaXY
Rotation about the XY plane
Type

Quantity

Read Only

ThetaYZ
Rotation about the YZ plane
Type

Quantity

Read Only

ThetaZX
Rotation about the ZX plane
Type

Quantity

Read Only

470

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

Mechanical Results
This container holds Results data for an instance of ANSYS Mechanical.

Methods
Edit
Opens the Mechanical editor and attaches geometry.
Optional Arguments
Interactive

Specify if Mechanical will open in interactive mode. The default value is true.
Type

bool

Default Value

True

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.
A reference to the requested MechanicalSystemType data entity.

Return

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.

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

471

Mechanical
Type

DataReference

Command argument containing the command.

Type

string

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\")")

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
Interactive

Specify if Mechanical will open in interactive mode. The default value is true.
Type

bool

Default Value

True

Example
To edit the setup component with default optional parameter values.

472

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

setup.Edit()

Or by specifying optional parameter values:

setup.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

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

SetupDataType

string

Type of setup data to write to disk. Available options are: 'InputFile' and 'CAERepresentation'.
Type

string

GetMechanicalSetupFile
Query to return the reference to the container's MechanicalSetupFile data entity.
A reference to the requested MechanicalSetupFile data entity.

Return

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

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

473

Mechanical

Command argument containing the command.

Type

string

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.

474

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

Read Only

SolverTarget
The type of assessment to be performed.
Type

string

Read Only

UserAttributeFile
The file to specify attributes to perform a User Defined design assessment.
Type

string

Read Only

Mechanical Solution
This container holds Solution data for an instance of ANSYS Mechanical.

Methods
Edit
Opens the Mechanical editor and attaches geometry.
Optional Arguments
Interactive

Specify if Mechanical will open in interactive mode. The default value is true.
Type

bool

Default Value

True

Example
To edit the solution component with default optional parameter values.
solution.Edit()

Or by specifying optional parameter values:

solution.Edit(Interactive=True)

Exit
Exit the Mechanical editor
Optional Arguments
SaveDatabase

Indicates whether the Mechanical database will be saved prior to exiting

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

475

Mechanical
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.
A reference to the requested MechanicalSystemType data entity.

Return

Type

DataReference

GetSolutionSettings
Returns a DataReference to the Solution Settings object for this container
The Data Entity containing settings for this component.

Return

Type

DataReference

Command argument containing the command.

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

Type

string

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.

string

Read Only

LimitOnNumberOfCores
The number of processes that the RSM-based design point update should not exceed during execution.
Type

int

Read Only

SerialOnly
Indicates whether or not to execute only serially.
Type

bool

Read Only

SharedMemoryParallel
A boolean flag indicating whether or not to restrict the solver to using SMP, instead of distributed
parallel
Type

bool

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

477

Mechanical
Read Only

UseLimitOnNumberOfCores
Indicates whether to limit the number of processes for parallel execution.
Type

bool

Read Only

SimulationSolutionSettings
Mechanical specific simulation solution settings entity used for Journaling and Scripting. Not based on
the common Infrastructure.Rsm.Queries entity.

string

Read Only

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

SolveProcessSetting
Solve process setting used on RSM task.
Type

string

Read Only

UpdateOption
Used to specify the type of update, local or RSM.
Type

478

string

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

Read Only

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

479

480

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

481

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.
A reference to the requested MechanicalMeshFile data entity.

Return

Type

DataReference

GetMechanicalModel
Returns the data reference to the container's MechanicalModel data entity.
Return

482

A reference to the requested MechanicalModel data entity.

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

Type

DataReference

GetMechanicalSystemType
Returns the data reference to the container's MechanicalSystemType data entity.
A reference to the requested MechanicalSystemType data entity.

Return

Type

DataReference

GetMeshingImportOptions
Query to return the data reference to the meshing import options
The Data Entity containing settings for this component.

Return

Type

DataReference

Type

string

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

string

Read Only

LengthUnit
Target Length Unit for Assembled Model
Type

484

string

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

Read Only

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

string

Read Only

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.
Type

int

Read Only

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

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.

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

485

Mesh

Properties
AnalysisTypeDisplayString
The string which represents the current analysis type setting - this value will always be "Any".
Type

string

Read Only

Yes

string

Read Only

PhysicsTypeDisplayString
The string which represents current physics type setting - the value can be "Any" or "CFD".
Type

string

Read Only

Yes

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

string

Read Only

NumberOfCopies
By default this value is 0, specifies how many additional copies of the upstream mesh are needed
Type
486

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

Read Only

OriginX
Displacement along the X axis
Type

Quantity

Read Only

OriginY
Displacement along the Y axis
Type

Quantity

Read Only

OriginZ
Displacement along the Z axis
Type

Quantity

Read Only

Source
The upstream mesh source
Type

DataReference

Read Only

ThetaXY
Rotation about the XY plane
Type

Quantity

Read Only

ThetaYZ
Rotation about the YZ plane
Type

Quantity

Read Only

ThetaZX
Rotation about the ZX plane
Type

Quantity

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

487

Mesh
Read Only

488

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 parameters.

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.
The DataReference of the MSExcelSetup entity.

Return

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.

string

Read Only

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

489

Microsoft Office Excel Analysis

ErrorMessage
Error message if the calculation failed.
Type

string

Read Only

FileName
Name of the file.
Type

string

Read Only

MacroName
Name of the macro used to calculate the workbook.
Type

string

Read Only

OriginalFilePath
Original Path of the file.
Type

string

Read Only

State
Calculation state of the file.
Type

Status

Read Only

UseMacro
Set to True if a Visual Basic macro is used to calculate the workbook.
Type

bool

Read Only

Methods
GetRange
Gets the DataReference of an MSExcelRange entity from its name. An exception is thrown if the entity
is not found.
Return

490

The DataRefence of the MSExcelRange entity.

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
The DataReferenceSet containing all the MSExcelRange entities associated
with the MSExcelFile.

Return

Type

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

493

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.

string

Read Only

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

494

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

UnitSystemName
The name of the unit system used for the Analysis container.
Type

string

Read Only

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.
The DataReference of the added file.

Return

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

495

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.
The DataReference of the retrieved file entity.

Return

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

496

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

Parameters
Parameters
This container hold project-level Parameters and Design Points.

Methods
GetAllParameters
Returns the set of all parameters associated with all entity properties in a given container. Parameters
not associated with containers are not returned.
The set of parameters present in the given container.

Return

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.

string

Read Only

Exported
Specifies whether the design point is exported.
Type

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

497

Parameters
Read Only

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 design point is up to date. False if the design point requires an update.
Type

bool

Read Only

Yes

Note
Contains user-defined notes about the design point.
Type

string

Read Only

Retained
Gets or sets whether the design point is retained.
Type

bool

Read Only

UpdateOrder
The update order of the design point.
Type

double

Read Only

Methods
AreParameterValuesEqual
Comparison to see if all parameter values within two different design points are equivalent.
True if all parameter values are equal.

Return

Type

bool

Required Arguments
DesignPoint2

498

The second design point

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

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.
The created design point entity.

Return

Type

DataReference

GetParameterValue
Returns the value of a specified parameter in a given design point.
The value of the parameter in the specified design point.

Return

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.
Required Arguments
Expression

The string with the expression for the parameter.

Type

Parameter

string

The input parameter data reference.

Type

DataReference

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

499

Parameters
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

string

Read Only

ErrorMessage
An error message as a result of a validation or expression evaluation error.
Type

string

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

500

string

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

Read Only

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

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.
To associate the parameter with a property, call AssociateParameter.
Required Arguments
Entity

The data model entity that holds the property to be disassociated.

Type

PropertyName

DataReference

The name of the property to be disassociated.

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

501

Parameters
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

PropertyName

DataReference

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.
A ParameterizedEntityPropertiesCollection dictionary containing a data
reference to each entity with parameterized properties and the list of
property names within that entity.

Return

Type

ParameterizedEntityPropertiesCollection

Optional Arguments
Container

Optionally specifies a container for which the entity properties should be returned.
Type

502

DataContainerReference

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

GetDependencies
For a derived parameter, returns the list of parameters referred to by this parameter's expression.
Data references to the parameters that this parameter is dependent
upon.

Return

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 understanding 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 CreateMultiAxisChart.
Type

DataReference

Read Only

string

Read Only

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

503

Parameters

IsBaseDesignPointExcluded
If this property is set the base design point will be excluded.
Type

bool

Read Only

Variables
The variables that have been added to the chart.
Type

DataReferenceSet

Read Only

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 CreateChartXY.
Type

DataReference

Read Only

string

Read Only

504

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

IsBaseDesignPointExcluded
If this property is set the base design point will be excluded.
Type

bool

Read Only

XAxisBottom
The parameter entity to be plotted on the primary (bottom) x-axis.
Type

DataReference

Read Only

XAxisTop
The parameter entity to be plotted on the secondary (top) x-axis.
Type

DataReference

Read Only

YAxisLeft
The parameter entity to be plotted on the left (primary) y-axis.
Type

DataReference

Read Only

YAxisRight
The parameter entity to be plotted on the right (secondary) y-axis.
Type

DataReference

Read Only

Methods
Delete
Deletes a parameter chart.

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

505

506

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Data Entities
PolydataPreference
Contains a reference to the preferences file for Polydata (setup editor). It is a provider of the preferences
file.

string

Read Only

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

509

Polyflow

File
Data reference to the preferences file for Polydata.
Type

DataReference

Read Only

PolyflowMesh
Contains a reference to a Polyflow mesh file. It is a provider for a Polyflow mesh file.

string

Read Only

File
Data reference to the mesh file
Type

DataReference

Read Only

PolyflowSetup
Contains a reference to a Polyflow data file. It is a provider of the data file (containing the setup).

string

Read Only

File
Data reference to the Polyflow Dat file
Type

DataReference

Read Only

510

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

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.
The PolyflowSolution object stored in the Polyflow Solution component.

Return

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.
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",
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

511

Polyflow
"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

restartKey

string

Restart key (among the list of available restart created by an upstream polyflow
system)
Type

resultKey

string

Result key (among the list of available results created by an upstream polyflow
system)
Type

solverRestartMode

string

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
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

512

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

solution1.StartListingViewer()
This command will launch the listing viewer tool (Polylst) on 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.

Data Entities
PolyflowPreference
Contains a reference to the preferences file for Polyflow (solver). It is a provider of the preferences file.

string

Read Only

File
Data reference to the preferences file for Polyflow.
Type

DataReference

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

513

Polyflow
Read Only

PolyflowSolution
Contains a reference to a Polyflow listing file. It is a provider of the listing file (containing a summary
of the simulation).

string

Read Only

File
Data reference to the listing file generated by the Polyflow solver and containing a summary of the
simulation.
Type

DataReference

Read Only

514

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.

string

Read Only

Notes
A note about the component.
Type

string

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

515

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.
Container Reference

Return

Type

DataContainerReference

Refresh
Refreshes the input data for a component by reading all changed data from upstream (source) components. 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

Optional Arguments
SourceSystem

The system from which to share the specified component.

Type

TargetSystem

The target system into which to share the component.

Type

516

DataReference

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

Example
The following example illustrates a replace of a component with a shared copy of another system's
component.
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

TransferDataName

DataReference

The name of the type of data to be transferred between components.

Type

string

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

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

517

Project

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.

string

Read Only

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

CreatedComponent

SystemPropertyDictionary

The created component.

Type

Name

Output<DataReference>

The name to use for the created component.

Type

UpstreamComponent

string

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)

518

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

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], Al

CustomProjectTemplate
A project snippet template containing multiple systems and their links.

string

Read Only

SystemNames
The names of the systems to create, one for each entry in the SystemTemplates list.
Type

List<string>

Read Only

SystemTemplates
Templates for the systems making up this snippet.
Type

List<DataReference>

Read Only

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.

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

519

Project

string

Read Only

Notes
A note about the project.
Type

string

Read Only

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

Components
The set of components which form this system.
Type

List<DataReference>

Read Only

string

Read Only

Notes
A note about the system.
Type
520

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

Read Only

Physics
The physics associated with this system.
Type

List<string>

Read Only

Solver
The solver associated with this system.
Type

List<string>

Read Only

Yes

Methods
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.
The reference to the created system.

Return

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

Name

The name for the new system.

Type

Position

string

Type of positioning of the new system.

Type

RelativeTo

List<DataReference>

PositionType

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".

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

521

Project

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.
Data Container Reference

Return

Type

DataReference

Required Arguments
Name Base Name of the Component
Type

string

GetContainer
Query to return the container for a given component base name in the system.
Data Container Reference

Return

Type

DataContainerReference

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

RelativeTo

522

PositionType

The system that the moved system is positioned relative to.

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

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.

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

DisplayName
The user-visible name for the type of systems created from this template.
Type

string

Read Only

string

Read Only

Physics
The physics assocated with this system template.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

523

Project
Type

List<string>

Read Only

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

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

Methods
CreateSystem
Creates a new system from a system template.
The reference to the created system.

Return

Type

DataReference

Optional Arguments
ComponentsToShare

A list of components to share into the newly created system.

Type

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

DataTransferTo

List<TransferDataToNewComponentSpec>

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

524

List<DataReference>

List<TransferDataFromNewComponentSpec>

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

Name

The name for the new system.

Type

Position

string

Type of positioning of the new system.

RelativeTo

Type

PositionType

Default Value

Default

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

Required Arguments
System

The existing system to replace.

Type

DataReference

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

525

Project
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

string

Read Only

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.
Type

List<string>

Read Only

Yes

526

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

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.
The set of file references associated with the container.

Return

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

string

Read Only

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

527

Project

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

Size
The size of the file in bytes.
Type

long

Read Only

Yes

Methods
Copy
Copies a file to a target directory.
A reference to the created file is returned in this argument.

Return

Type

DataReference

Required Arguments
DestinationDirectoryPath

The full path to the destination directory.

Type

528

string

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

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, CopyReference

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.

DeleteIfShared

ErrorIfShared

Type

bool

Default Value

True

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

Specifies whether to throw an exception when trying to delete a shared file if DeleteIfShared 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 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")
fileRef.Delete(ErrorIfShared=False)

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

529

Project

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
NewName

The new file name, excluding the directory path. To change the directory, see MoveFileCommand.
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)

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

530

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

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

string

Read Only

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

LastDownloadRepositoryModificationTime
Modifed time stamp of file at the download time
Type

DateTime

Read Only

LastDownloadTime
Last downloaded time from repostiroy server
Type

long

Read Only

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

531

Project

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

Size
The size of the local file in bytes.
Type

long

Read Only

Yes

SourceFileInfo
Repository file info holder of
Type

RepositoryFileInfo

Read Only

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

Read Only

Yes

532

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

DateTimeStamp
The publication time.
Type

DateTime

Read Only

Yes

Details
The detailed text string of the message.
Type

string

Read Only

Yes

string

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

533

534

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
The new data transfer that was created.

Return

Type

DataReference

Required Arguments
Name The name for this data transfer.
Type

string

Optional Arguments
SourceParticipant

Type

DataReference

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

535

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.

536

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 collection is empty.
Collection of the data transfers in the container.

Return

Type

DataReferenceSet

GetDebugOutputControls
Returns the debug output controls from a system coupling setup container.
Data reference of the debug output controls in the container.

Return

Type

DataReference

GetExpertSettings
Returns the expert settings entity from a system coupling setup container.
Data reference of the expert settings in the container.

Return

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.
Data reference of the intermediate result files output controls in the
container.

Return

Type

DataReference

GetParticipant
Returns the participant with a given name from a system coupling setup container.
The participant that matches the specified name.

Return

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

537

System Coupling
Collection of the participants in the container.

Return

Type

DataReferenceSet

GetSequenceControls
Returns the sequence controls from a system coupling setup container.
Data reference of the sequence controls in the container.

Return

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

DisableSolutionUpdate
This flag disables updates if restarts are not supported and solution data exists
Type

bool

Read Only

string

Read Only

DurationDefinedBy
This property specifies how we should determine the end of the coupling run.
Type

538

DurationType

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

Read Only

EndTime
The end time for the coupling run
Type

Quantity

Read Only

Initialization
The initialziation setting.
Type

InitializationType

Read Only

MaximumIteration
The maximum number of iterations per coupling step for the coupling run.
Type

int

Read Only

MinimumIteration
The minimum number of iterations per coupling step for the coupling run.
Type

int

Read Only

NumberOfSteps
The number of time steps for the coupling run.
Type

int

Read Only

RestartStep
The restart step for the coupling run.
Type

int

Read Only

RestartTime
The restart time for the coupling run.
Type

Quantity

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

539

System Coupling
Read Only

StepSize
The step size for the coupling run.
Type

Quantity

Read Only

DataTransfer
Entity to store a data transfer information.

string

Read Only

IsSuppressed
Suppression state of the entity.
Type

bool

Read Only

SourceParticipant
Participant system providing the data.
Type

DataReference

Read Only

SourceRegion
Participant region providing the data.
Type

DataReference

Read Only

SourceVariable
Variable provided by the source participant.
Type

DataReference

Read Only

540

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

TargetParticipant
Participant consuming the data.
Type

DataReference

Read Only

TargetRegion
Participant region consuming the data.
Type

DataReference

Read Only

TargetVariable
Variable consumed by the target participant.
Type

DataReference

Read Only

TransferSettings
Settings to specify how the data transfers are executed.
Type

DataReference

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

541

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

string

Read Only

Ramping
Setting that defines the ramping.
Type

RampingType

Read Only

TransferAt
Setting that defines when the transfers should happen.
Type

TransferAtType

Read Only

UnderRelaxationFactor
Convergence stability factor for highly non-linear couplings.
Type

double

Read Only

542

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 synchronization point.
Type

DebugLevel

Read Only

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

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

string

Read Only

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

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

543

System Coupling

ParticipantConnection
This setting controls the level of output from the end of the setup validation until the Analysis Initalization synchronization point.
Type

DebugLevel

Read Only

Shutdown
This setting controls the level of output after the Shutdown synchronization point.
Type

DebugLevel

Read Only

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

SourceData
This setting controls the level of output for the source data in all data transfers.
Type

DebugLevel

Read Only

SourceMeshCoordinates
This setting controls the level of output for mesh coordinates of the source region in all data transfers.
Type

DebugLevel

Read Only

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

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.

544

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

Type

DebugLevel

Read Only

TargetData
This setting controls the level of output for the target data in all data transfers.
Type

DebugLevel

Read Only

TargetMeshCoordinates
This setting controls the level of output for mesh coordinates of the source region in all data transfers.
Type

DebugLevel

Read Only

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

ExpertSettings
The entity to store advanced options for data mapping.

string

Read Only

Settings
The expert setting parameters dictionary.
Type

Dictionary<string, string>

Read Only

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

545

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.
The value of the property.

Return

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

Value

string

The value of the property.

Type

string

IntermediateResultFilesOutputControls
The entity to store the settings for result files creation during a coupling run.

546

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

string

Read Only

OutputFrequency
This property specifies the frequency at which the result files are generated.
Type

OutputFrequencyType

Read Only

StepInterval
The step interval at which the result files are generated.
Type

int

Read Only

SequenceControl
The entity to store solver sequence information for a coupling run.

string

Read Only

Sequence
Dictionary containing sequence values for each participant.
Type

Dictionary<DataReference, int>

Read Only

Methods
GetSequence
Returns the sequence value for a participant.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

547

System Coupling
Sequence value for the given participant.

Return

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

Value

DataReference

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.

string

Read Only

InternalName
The internal name of the multiphysics participant (usually a solver) that is providing this data
Type

string

Read Only

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

548

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

string

Read Only

InternalName
The internal name of the multiphysics participant (usually a solver) that is providing this data
Type

string

Read Only

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.

string

Read Only

InternalName
The name of the region as understood by the solver
Type

string

Read Only

Topology
The topology of the region
Type

TopologyType

Read Only

SystemCouplingStaticDataParticipant
This is a base class/entity for the entity which represents System Coupling Static Data Participant information.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

549

System Coupling

string

Read Only

InternalName
The internal name of the multiphysics participant (usually a solver) that is providing this data
Type

string

Read Only

SystemCouplingSteadyCoSimulationParticipant
The entity represents System Coupling Steady Co-simulation Participant information e.g. information
related to Static Structural Participant System for coupling purpose.

string

Read Only

InternalName
The internal name of the multiphysics participant (usually a solver) that is providing this data
Type

string

Read Only

SystemCouplingSteadyStaticDataParticipant
The entity represents System Coupling Steady Static Data Participant information e.g. information related
to External Data Participant System for coupling purposes.

550

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

Type

string

Read Only

InternalName
The internal name of the multiphysics participant (usually a solver) that is providing this data
Type

string

Read Only

SystemCouplingTransientCoSimulationParticipant
The entity represents System Coupling Transient Co-simulation Participant information e.g. information
related to Transient Structural Participant System for coupling purposes.

string

Read Only

InternalName
The internal name of the multiphysics participant (usually a solver) that is providing this data
Type

string

Read Only

SystemCouplingTransientStaticDataParticipant
The entity represents System Coupling Transient Static Data Participant information.

string

Read Only

InternalName
The internal name of the multiphysics participant (usually a solver) that is providing this data

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

551

System Coupling
Type

string

Read Only

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

string

Read Only

Exposure
The type of transfer that will be done with this variable
Type

VariableExposure

Read Only

InternalName
The name of the variable
Type

string

Read Only

PhysicalType
The quantity type of the variable
Type

string

Read Only

552

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
The data reference to the new convergence chart.

Return

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.
The new solution information that was created.

Return

Type

DataReference

Required Arguments
Name

The name for this Solution Information.

Type

SolutionInformationFilePath

string

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.
Collection of the solution informations in the container.

Return

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

553

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.
The convergence chart that matches the specified name.

Return

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.
Collection of the convergence charts in the container.

Return

Type

DataReferenceSet

GetSolutionComponentProperties
Returns the solution component properties for a system coupling solution container.
Data reference to the properties objects.

Return

Type

DataReference

GetSolutionInformation
Returns the solution information of a given name in a container.

554

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

The solution information that matches the specified name.

Return

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

string

Read Only

QuantityName
The name of the quantity associated with axis data.
E.g. Coupling Iteration, Coupling Step, Coupling Time
Type

string

Read Only

RangeMaximum
The maximum range of the values in this axis.
Type

double

Read Only

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

555

System Coupling

RangeMinimum
The minimum range of the values in this axis.
Type

double

Read Only

Scale
The scale of the axis. Scale can be defined as Linear/CommonLog (Log base 10)/Natural Log.
Type

Scale

Read Only

Title
The title of the axis.
Type

string

Read Only

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

string

Read Only

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

556

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

Read Only

QualifiedName
The variable quantity to display.
Type

string

Read Only

RefinementLevel
Refinement level for the data to be plotted.
Type

string

Read Only

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

Methods
Delete
Deletes a specified chart variable.

ConvergenceChart
Entity to store a convergence chart information.

Properties
AxisX
Associated X Axis
Type

DataReference

Read Only

AxisY
Associated Y Axis
Type

DataReference

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

557

System Coupling
Read Only

string

Read Only

Variables
Collection of variables to be plotted.
Type

DataReferenceSet

Read Only

XAxis
X Axis Quantity Name
Type

string

Read Only

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. GetChartVariableNames 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

558

DataReference

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

Required Arguments
QualifiedName

The fully qualified name for this chart variable.

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

string

Read Only

SolutionInformation
Entity to store the solution information provided by the coupled participants.

string

Read Only

FilePath
The path of the solution information file.

560

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

Type

string

Read Only

Methods
Delete
Deletes a specified solution information entity.

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

561

562

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

563

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

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 direction through curves that run from hub to
shroud.
Loft the blade surfaces in the spanwise direction through the blade profile curves.

Spanwise
Type

BladeLoftType

Read Only

564

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
Only one blade will be created.

False
Type

bool

Read Only

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
False

Create the fluid zone Enclosure.

Don't create the fluid zone Enclosure.

Type

bool

Read Only

CreateHub
Import Option that specifies whether a hub body will be created when the Blade Design data is transferred 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 HubBody.
BladeEditor will not create the hub body.

False
Type

bool

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

565

TurboSystems
other ANSYS Workbench applications. Note that this property is available only if Create Fluid Zone is
selected.
Available options:
True
False

Create the Named Selections.

Don't create the Named Selections.

Type

bool

Read Only

string

Read Only

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

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

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,

566

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.
Don't merge the blade faces.

False
Type

bool

Read Only

ModelUnits
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

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

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
ThreePieces

The periodic surface is created as a single

surface.
The periodic surface is created in three connected pieces: one upstream of the blade, one
within the passage, and one downstream of
the blade. This style can better accommodate
highly curved or twisted blades, and is similar

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

567

TurboSystems
to the ANSYS TurboGrid style of periodic surface.
Type

PeriodicSurfType

Read Only

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
RelativeLayer

No shroud clearance is created.

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.
The selected layer index counts up from the
hub layer, which is zero.

AbsoluteLayer
Type

ClearanceType

Read Only

SpanwiseCount
The number of spanwise gridlines used in the downstream VistaTF calculation. Default = 4
Type

int

Read Only

StreamwiseCount
The number of streamwise gridlines used in the downstream VistaTF calculation. Default = 20
Type

int

Read Only

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.

568

Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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.

TopologySuspended

Type

bool

Default Value

True

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

GetTurboMeshProperties
Returns the Data Entity which contains user settings and properties for the Turbo Mesh container.
A reference to the requested data entity.

Return

Type

DataReference

Valid CFX Command Language (CCL) commands

Type

string

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

569

TurboSystems

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

string

Read Only

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

InletBlock
If this is checked then an inlet block will be generated, if possible, when the mesh is created.
Type

bool

Read Only

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

570

The user will specify the inlet points in TurboGrid.

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

AdjacentBlade

TurboGrid will calculate the inlet points to be

halfway between the selected upstream
bladerow and the current bladerow.

Type

OpeningPositionMethod

Read Only

MaximumFaceAngle
This is the maximum face angle in the mesh if the mesh has been generated.
Type

Quantity

Read Only

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.
Type

string

Read Only

MinimumFaceAngle
This is the minimum face angle in the mesh if the mesh has been generated.
Type

Quantity

Read Only

OutletBlock
If this is checked then an outlet block will be generated, if possible, when the mesh is created.
Type

bool

Read Only

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 TurboGrid.

TurboGrid will calculate the outlet points to
be halfway between the selected downstream
bladerow and the current bladerow.

AdjacentBlade

Type

OpeningPositionMethod

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

571

TurboSystems
Read Only

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

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

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

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.
Optional Arguments
Beta

Option to use the beta BladeGen template

Type

bool

Default Value

False

CreateGeometry
This command class creates a new BladeEditor model. An up-to-date Geometry cell appears on the
project schematic containing the new model.

572

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

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.
Reference to the requested Data Entity

Return

Type

DataReference

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

Alpha3
User input, OGV exit angle
Type

Quantity

Read Only

AlphaOGVHub
OGV hub gas exit angle
Type

Quantity

Read Only

AlphaOGVMean
OGV mean gas exit angle
Type

Quantity

Read Only

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

573

TurboSystems

AlphaRotHub
Rotor hub gas exit angle
Type

Quantity

Read Only

AlphaRotMean
Rotor mean gas exit angle
Type

Quantity

Read Only

Blade
Blade number to export to Bladegen (0=IGV, 1=Rotor, 2=OGV)
Type

int

Read Only

BladeBetaExit
Blade exit angles
Type

List<List<float>>

Read Only

BladeBetaInlet
Blade inlet angles
Type

List<List<float>>

Read Only

BladeOption
Blade option for export to BladeGen
Type

BladeType

Read Only

BMunits
BladeGen/BladeEditor units
Type

string

Read Only

574

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

BMunitsOption
BladeGen/BladeEditor units option
Type

BMunitsType

Read Only

DeHallerOGVHub
OGV hub DeHaller number
Type

float

Read Only

DeHallerOGVMean
OGV mean DeHaller number
Type

float

Read Only

DeHallerRotHub
Rotor hub DeHaller number
Type

float

Read Only

DeHallerRotMean
Rotor mean DeHaller number
Type

float

Read Only

DevIGVHub
IGV hub deviation
Type

Quantity

Read Only

DevIGVMean
IGV mean deviation
Type

Quantity

Read Only

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

575

TurboSystems

DevOGVHub
OGV hub deviation
Type

Quantity

Read Only

DevOGVMean
OGV mean deviation
Type

Quantity

Read Only

DevRotHub
Rotor hub deviation
Type

Quantity

Read Only

DevRotMean
Rotor mean deviation
Type

Quantity

Read Only

DfOGVHub
OGV hub diffusion factor
Type

float

Read Only

DfOGVMean
OGV mean diffusion factor
Type

float

Read Only

DfRotHub
Rotor hub diffusion factor
Type

float

Read Only

576

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

DfRotMean
Rotor mean diffusion factor
Type

float

Read Only

Diameter
User input, outer diameter
Type

Quantity

Read Only

string

Read Only

Eta
Aerodynamic efficiency
Type

float

Read Only

EtaInput
User input, efficiency estimate
Type

float

Read Only

EtaTS
System efficiency (t-s)
Type

float

Read Only

EtaTSPipe
Downstream system efficiency (t-s)
Type

float

Read Only

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

577

TurboSystems

EtaTT
System efficiency (t-t)
Type

float

Read Only

HeadRise
User input, total head rise
Type

Quantity

Read Only

HtrIn
User input, hub/tip rotor inlet
Type

float

Read Only

HtrOut
User input, hub/tip rotor outlet
Type

float

Read Only

HubLoadParam
User input, hub loading parameter
Type

float

Read Only

HubVelFactor
User input, hub velocity deficit factor
Type

float

Read Only

HubX
Hub annulus X-coords
Type

List<Quantity>

Read Only

578

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

HubY
Hub annulus Y-coords
Type

List<Quantity>

Read Only

IGV
User input, IGV option
Type

bool

Read Only

IGVhubThickX
IGV hub thickness X-coord
Type

List<float>

Read Only

IGVhubThickY
IGV hub thickness Y-coord
Type

List<Quantity>

Read Only

IGVleadingX
IGV leading edge X-coords
Type

List<Quantity>

Read Only

IGVleadingY
IGV leading edge Y-coords
Type

List<Quantity>

Read Only

IGVshrThickX
IGV shroud thickness X-coord
Type

List<float>

Read Only

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

579

TurboSystems

IGVshrThickY
IGV shroud thickness Y-coord
Type

List<Quantity>

Read Only

IGVthetaLE
IGV leading edge theta
Type

List<float>

Read Only

IGVtrailingX
IGV trailing edge X-coords
Type

List<Quantity>

Read Only

IGVtrailingY
IGV trailing edge Y-coords
Type

List<Quantity>

Read Only

ImperialUnits
User input, Imperial units option
Type

bool

Read Only

InnerIter
User input, number of inner loop design calculation iterations
Type

int

Read Only

Layer1
Intermediate spanwise layer1 for Export
Type

bool

Read Only

580

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

Layer2
Intermediate spanwise layer2 for Export
Type

bool

Read Only

Layer3
Intermediate spanwise layer3 for Export
Type

bool

Read Only

LoadHub
Rotor hub loading
Type

float

Read Only

LoadMean
Rotor mean loading
Type

float

Read Only

MassFlow
User input, mass flow rate
Type

Quantity

Read Only

MaxLoadHub
Rotor maximum hub loading
Type

float

Read Only

MaxLoadMean
Rotor maximum mean loading
Type

float

Read Only

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

581

TurboSystems

MixLoss
User input, downstream mixing losses
Type

float

Read Only

NMain
Number of blades in each row
Type

List<int>

Read Only

OGV
User input, OGV option
Type

bool

Read Only

OGVhubThickX
OGV hub thickness X-coord
Type

List<float>

Read Only

OGVhubThickY
OGV hub thickness Y-coord
Type

List<Quantity>

Read Only

OGVleadingX
OGV leading edge X-coords
Type

List<Quantity>

Read Only

OGVleadingY
OGV leading edge Y-coords
Type

List<Quantity>

Read Only

582

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

OGVshrThickX
OGV shroud thickness X-coord
Type

List<float>

Read Only

OGVshrThickY
OGV shroud thickness Y-coord
Type

List<Quantity>

Read Only

OGVthetaLE
OGV leading edge theta
Type

List<float>

Read Only

OGVtrailingX
OGV trailing edge X-coords
Type

List<Quantity>

Read Only

OGVtrailingY
OGV trailing edge Y-coords
Type

List<Quantity>

Read Only

Omega
User input, rotational speed
Type

Quantity

Read Only

OuterIter
User input, number of outer loop design calculation iterations
Type

int

Read Only

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

583

TurboSystems

Pdyn
Outlet dynamic pressure
Type

Quantity

Read Only

PdynPipe
Downstream dynamic pressure
Type

Quantity

Read Only

PhiHub
Rotor hub flow coefficient
Type

float

Read Only

PhiMean
Rotor mean flow coefficient
Type

float

Read Only

Power
Power
Type

Quantity

Read Only

RatioIGV
User input, IGV aspect ratio
Type

float

Read Only

RatioOGV
User input, OGV aspect ratio
Type

float

Read Only

584

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

RatioRotor
User input, Rotor aspect ratio
Type

float

Read Only

RotorHubThickX
Rotor hub thickness X-coord
Type

List<float>

Read Only

RotorHubThickY
Rotor hub thickness Y-coord
Type

List<Quantity>

Read Only

RotorLeadingX
Rotor leading edge X-coords
Type

List<Quantity>

Read Only

RotorLeadingY
Rotor leading edge Y-coords
Type

List<Quantity>

Read Only

RotorShrThickX
Rotor shroud thickness X-coord
Type

List<float>

Read Only

RotorShrThickY
Rotor shroud thickness Y-coord
Type

List<Quantity>

Read Only

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

585

TurboSystems

RotorThetaLE
Rotor leading edge theta
Type

List<float>

Read Only

RotorTrailingX
Rotor trailing edge X-coords
Type

List<Quantity>

Read Only

RotorTrailingY
Rotor trailing edge Y-coords
Type

List<Quantity>

Read Only

Sc90MaxIter
User input, maximum number of solver iterations
Type

int

Read Only

Sc90Relax
User input, solver relaxation factor
Type

float

Read Only

Sc90Tol
User input, solver tolerance
Type

float

Read Only

ShrX
Shroud annulus X-coords
Type

List<Quantity>

Read Only

586

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

ShrY
Shroud annulus Y-coords
Type

List<Quantity>

Read Only

SIunits
User input, SI units option
Type

bool

Read Only

Span
Spanwise fractions
Type

List<float>

Read Only

StagPressure
User input, inlet stagnation pressure
Type

Quantity

Read Only

StagTemp
User input, inlet stagnation temperature
Type

Quantity

Read Only

Torque
Torque
Type

Quantity

Read Only

TrimIGV
User input, IGV profile trim
Type

float

Read Only

587

TurboSystems

TrimOGV
User input, OGV profile trim
Type

float

Read Only

TrimRotor
User input, Rotor profile trim
Type

float

Read Only

VanesIGV
User input, IGV number of vanes
Type

int

Read Only

VanesOGV
User input, OGV number of vanes
Type

int

Read Only

VanesRotor
User input, Rotor number of vanes
Type

int

Read Only

VistaAFDTitle
Editor Title
Type

string

Read Only

588

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.
Optional Arguments
Beta

Option to use the beta BladeGen template

Type

bool

Default Value

False

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
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.
Reference to the requested Data Entity

Return

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

589

TurboSystems

Alpha3
User input, OGV exit angle
Type

Quantity

Read Only

AlphaOGVHub
OGV hub gas exit angle
Type

Quantity

Read Only

AlphaOGVMean
OGV mean gas exit angle
Type

Quantity

Read Only

AlphaRotHub
Rotor hub gas exit angle
Type

Quantity

Read Only

AlphaRotMean
Rotor mean gas exit angle
Type

Quantity

Read Only

Blade
Blade number to export to Bladegen (0=IGV, 1=Rotor, 2=OGV)
Type

int

Read Only

BladeBetaExit
Blade exit angles
Type

List<List<float>>

Read Only

590

BladeBetaInlet
Blade inlet angles
Type

List<List<float>>

Read Only

BladeOption
Blade option for export to BladeGen
Type

BladeType

Read Only

BMunits
BladeGen/BladeEditor units
Type

string

Read Only

BMunitsOption
BladeGen/BladeEditor units option
Type

BMunitsType

Read Only

DeHallerOGVHub
OGV hub DeHaller number
Type

float

Read Only

DeHallerOGVMean
OGV mean DeHaller number
Type

float

Read Only

DeHallerRotHub
Rotor hub DeHaller number
Type

float

Read Only

591

TurboSystems

DeHallerRotMean
Rotor mean DeHaller number
Type

float

Read Only

DevIGVHub
IGV hub deviation
Type

Quantity

Read Only

DevIGVMean
IGV mean deviation
Type

Quantity

Read Only

DevOGVHub
OGV hub deviation
Type

Quantity

Read Only

DevOGVMean
OGV mean deviation
Type

Quantity

Read Only

DevRotHub
Rotor hub deviation
Type

Quantity

Read Only

DevRotMean
Rotor mean deviation
Type

Quantity

Read Only

592

DfOGVHub
OGV hub diffusion factor
Type

float

Read Only

DfOGVMean
OGV mean diffusion factor
Type

float

Read Only

DfRotHub
Rotor hub diffusion factor
Type

float

Read Only

DfRotMean
Rotor mean diffusion factor
Type

float

Read Only

Diameter
User input, outer diameter
Type

Quantity

Read Only

string

Read Only

Eta
Aerodynamic efficiency
Type

float

Read Only

593

TurboSystems

EtaInput
User input, efficiency estimate
Type

float

Read Only

EtaTS
System efficiency (t-s)
Type

float

Read Only

EtaTSPipe
Downstream system efficiency (t-s)
Type

float

Read Only

EtaTT
System efficiency (t-t)
Type

float

Read Only

HeadRise
User input, total head rise
Type

Quantity

Read Only

HtrIn
User input, hub/tip rotor inlet
Type

float

Read Only

HtrOut
User input, hub/tip rotor outlet
Type

float

Read Only

594

HubLoadParam
User input, hub loading parameter
Type

float

Read Only

HubVelFactor
User input, hub velocity deficit factor
Type

float

Read Only

HubX
Hub annulus X-coords
Type

List<Quantity>

Read Only

HubY
Hub annulus Y-coords
Type

List<Quantity>

Read Only

IGV
User input, IGV option
Type

bool

Read Only

IGVhubThickX
IGV hub thickness X-coord
Type

List<float>

Read Only

IGVhubThickY
IGV hub thickness Y-coord
Type

List<Quantity>

Read Only

595

TurboSystems

IGVleadingX
IGV leading edge X-coords
Type

List<Quantity>

Read Only

IGVleadingY
IGV leading edge Y-coords
Type

List<Quantity>

Read Only

IGVshrThickX
IGV shroud thickness X-coord
Type

List<float>

Read Only

IGVshrThickY
IGV shroud thickness Y-coord
Type

List<Quantity>

Read Only

IGVthetaLE
IGV leading edge theta
Type

List<float>

Read Only

IGVtrailingX
IGV trailing edge X-coords
Type

List<Quantity>

Read Only

IGVtrailingY
IGV trailing edge Y-coords
Type

List<Quantity>

Read Only

596

ImperialUnits
User input, Imperial units option
Type

bool

Read Only

InnerIter
User input, number of inner loop design calculation iterations
Type

int

Read Only

Layer1
Intermediate spanwise layer1 for Export
Type

bool

Read Only

Layer2
Intermediate spanwise layer2 for Export
Type

bool

Read Only

Layer3
Intermediate spanwise layer3 for Export
Type

bool

Read Only

LoadHub
Rotor hub loading
Type

float

Read Only

LoadMean
Rotor mean loading
Type

float

Read Only

597

TurboSystems

MassFlow
User input, mass flow rate
Type

Quantity

Read Only

MaxLoadHub
Rotor maximum hub loading
Type

float

Read Only

MaxLoadMean
Rotor maximum mean loading
Type

float

Read Only

MixLoss
User input, downstream mixing losses
Type

float

Read Only

NMain
Number of blades in each row
Type

List<int>

Read Only

OGV
User input, OGV option
Type

bool

Read Only

OGVhubThickX
OGV hub thickness X-coord
Type

List<float>

Read Only

598

OGVhubThickY
OGV hub thickness Y-coord
Type

List<Quantity>

Read Only

OGVleadingX
OGV leading edge X-coords
Type

List<Quantity>

Read Only

OGVleadingY
OGV leading edge Y-coords
Type

List<Quantity>

Read Only

OGVshrThickX
OGV shroud thickness X-coord
Type

List<float>

Read Only

OGVshrThickY
OGV shroud thickness Y-coord
Type

List<Quantity>

Read Only

OGVthetaLE
OGV leading edge theta
Type

List<float>

Read Only

OGVtrailingX
OGV trailing edge X-coords
Type

List<Quantity>

Read Only

599

TurboSystems

OGVtrailingY
OGV trailing edge Y-coords
Type

List<Quantity>

Read Only

Omega
User input, rotational speed
Type

Quantity

Read Only

OuterIter
User input, number of outer loop design calculation iterations
Type

int

Read Only

Pdyn
Outlet dynamic pressure
Type

Quantity

Read Only

PdynPipe
Downstream dynamic pressure
Type

Quantity

Read Only

PhiHub
Rotor hub flow coefficient
Type

float

Read Only

PhiMean
Rotor mean flow coefficient
Type

float

Read Only

600

Power
Power
Type

Quantity

Read Only

RatioIGV
User input, IGV aspect ratio
Type

float

Read Only

RatioOGV
User input, OGV aspect ratio
Type

float

Read Only

RatioRotor
User input, Rotor aspect ratio
Type

float

Read Only

RotorHubThickX
Rotor hub thickness X-coord
Type

List<float>

Read Only

RotorHubThickY
Rotor hub thickness Y-coord
Type

List<Quantity>

Read Only

RotorLeadingX
Rotor leading edge X-coords
Type

List<Quantity>

Read Only

601

TurboSystems

RotorLeadingY
Rotor leading edge Y-coords
Type

List<Quantity>

Read Only

RotorShrThickX
Rotor shroud thickness X-coord
Type

List<float>

Read Only

RotorShrThickY
Rotor shroud thickness Y-coord
Type

List<Quantity>

Read Only

RotorThetaLE
Rotor leading edge theta
Type

List<float>

Read Only

RotorTrailingX
Rotor trailing edge X-coords
Type

List<Quantity>

Read Only

RotorTrailingY
Rotor trailing edge Y-coords
Type

List<Quantity>

Read Only

Sc90MaxIter
User input, maximum number of solver iterations
Type

int

Read Only

602

Sc90Relax
User input, solver relaxation factor
Type

float

Read Only

Sc90Tol
User input, solver tolerance
Type

float

Read Only

ShrX
Shroud annulus X-coords
Type

List<Quantity>

Read Only

ShrY
Shroud annulus Y-coords
Type

List<Quantity>

Read Only

SIunits
User input, SI units option
Type

bool

Read Only

Span
Spanwise fractions
Type

List<float>

Read Only

StagPressure
User input, inlet stagnation pressure
Type

Quantity

Read Only

603

TurboSystems

StagTemp
User input, inlet stagnation temperature
Type

Quantity

Read Only

Torque
Torque
Type

Quantity

Read Only

TrimIGV
User input, IGV profile trim
Type

float

Read Only

TrimOGV
User input, OGV profile trim
Type

float

Read Only

TrimRotor
User input, Rotor profile trim
Type

float

Read Only

VanesIGV
User input, IGV number of vanes
Type

int

Read Only

VanesOGV
User input, OGV number of vanes
Type

int

Read Only

604

VanesRotor
User input, Rotor number of vanes
Type

int

Read Only

VistaAFDTitle
Editor Title
Type

string

Read Only

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.
Reference to the requested Data Entity

Return

Type

DataReference

Import
This command imports Vista data into the Blade Design cell from an existing BladeGen file. If no appropriate 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

605

TurboSystems

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

Alpha3
User input, OGV exit angle
Type

Quantity

Read Only

AlphaOGVHub
OGV hub gas exit angle
Type

Quantity

Read Only

AlphaOGVMean
OGV mean gas exit angle
Type

Quantity

Read Only

AlphaRotHub
Rotor hub gas exit angle
Type

Quantity

Read Only

AlphaRotMean
Rotor mean gas exit angle
Type

Quantity

Read Only

606

DeHallerOGVHub
OGV hub DeHaller number
Type

float

Read Only

DeHallerOGVMean
OGV mean DeHaller number
Type

float

Read Only

DeHallerRotHub
Rotor hub DeHaller number
Type

float

Read Only

DeHallerRotMean
Rotor mean DeHaller number
Type

float

Read Only

Diameter
User input, outer diameter
Type

Quantity

Read Only

string

Read Only

Eta
Aerodynamic efficiency
Type

float

Read Only

607

TurboSystems

EtaInput
User input, efficiency estimate
Type

float

Read Only

EtaTS
System efficiency (t-s)
Type

float

Read Only

EtaTSPipe
Downstream system efficiency (t-s)
Type

float

Read Only

EtaTT
System efficiency (t-t)
Type

float

Read Only

HeadRise
User input, total head rise
Type

Quantity

Read Only

HtrIn
User input, hub/tip rotor inlet
Type

float

Read Only

HtrOut
User input, hub/tip rotor outlet
Type

float

Read Only

608

HubLoadParam
User input, hub loading parameter
Type

float

Read Only

HubVelFactor
User input, hub velocity deficit factor
Type

float

Read Only

HubX
Hub annulus X-coords
Type

List<Quantity>

Read Only

HubY
Hub annulus Y-coords
Type

List<Quantity>

Read Only

IGV
User input, IGV option
Type

bool

Read Only

ImperialUnits
User input, Imperial units option
Type

bool

Read Only

LoadHub
Rotor hub loading
Type

float

Read Only

609

TurboSystems

LoadMean
Rotor mean loading
Type

float

Read Only

MassFlow
User input, mass flow rate
Type

Quantity

Read Only

MaxLoadHub
Rotor maximum hub loading
Type

float

Read Only

MaxLoadMean
Rotor maximum mean loading
Type

float

Read Only

MixLoss
User input, downstream mixing losses
Type

float

Read Only

OGV
User input, OGV option
Type

bool

Read Only

Omega
User input, rotational speed
Type

Quantity

Read Only

610

Pdyn
Outlet dynamic pressure
Type

Quantity

Read Only

PdynPipe
Downstream dynamic pressure
Type

Quantity

Read Only

PhiHub
Rotor hub flow coefficient
Type

float

Read Only

PhiMean
Rotor mean flow coefficient
Type

float

Read Only

Power
Power
Type

Quantity

Read Only

RatioIGV
User input, IGV aspect ratio
Type

float

Read Only

RatioOGV
User input, OGV aspect ratio
Type

float

Read Only

611

TurboSystems

RatioRotor
User input, Rotor aspect ratio
Type

float

Read Only

ShrX
Shroud annulus X-coords
Type

List<Quantity>

Read Only

ShrY
Shroud annulus Y-coords
Type

List<Quantity>

Read Only

SIunits
User input, SI units option
Type

bool

Read Only

StagPressure
User input, inlet stagnation pressure
Type

Quantity

Read Only

StagTemp
User input, inlet stagnation temperature
Type

Quantity

Read Only

Torque
Torque
Type

Quantity

Read Only

612

TrimIGV
User input, IGV profile trim
Type

float

Read Only

TrimOGV
User input, OGV profile trim
Type

float

Read Only

TrimRotor
User input, Rotor profile trim
Type

float

Read Only

VanesIGV
User input, IGV number of vanes
Type

int

Read Only

VanesOGV
User input, OGV number of vanes
Type

int

Read Only

VanesRotor
User input, Rotor number of vanes
Type

int

Read Only

VistaAFDTitle
Editor Title
Type

string

Read Only

613

TurboSystems

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.
Optional Arguments
Beta

Option to use the beta BladeGen template

Type

bool

Default Value

False

CreateGeometry
This command class creates a new BladeEditor model. An up-to-date Geometry cell appears on the
project schematic containing the new model.

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 a new Turbomachinery Fluid Flow system. The new system appears on the
project schematic containing Geometry (BladeGen or BladeEditor), Turbo Mesh, Setup, Solution and
Results cells. The Geometry, Turbo Mesh and Setup cells are automatically updated, leaving the CFD
Solution 'ready to run'.
Optional Arguments
UseBladegen

614

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.

GetVistaCCDBladeDesignProperties
This query takes a container reference and returns the Data Entity which contains user settings and
properties for the VistaCCD Blade Design container.
Reference to the requested Data Entity

Return

Type

DataReference

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

Alpha3
This property specifies the flow angle at the impeller inlet in the absolute reference frame.
Type

Quantity

Read Only

615

TurboSystems

Alpha5rms
This property reports the absolute flow angle at the impeller trailing edge.
Type

Quantity

Read Only

AnChkRatio
This property reports the annulus choke ratio.
Type

float

Read Only

B5
This property reports the axial distance between hub and shroud at the impeller trailing edge (tip width).
Type

Quantity

Read Only

Beta5rms
This property reports the relative flow angle at the impeller trailing edge.
Type

Quantity

Read Only

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

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

Read Only

BetaBlade5
This property specifies the impeller backsweep angle.
Type

616

Quantity

Read Only

BetaBladeLEhub
This property reports the blade angle at the impeller leading edge hub location.
Type

Quantity

Read Only

BetaBladeLErms
This property reports the blade angle at the impeller leading edge meanline location.
Type

Quantity

Read Only

BetaBladeLEshr
This property reports the blade angle at the impeller leading edge shroud location.
Type

Quantity

Read Only

BetaLEhub
This property reports the relative flow angle at the impeller leading edge hub location.
Type

Quantity

Read Only

BetaLErms
This property reports the relative flow angle at the impeller leading edge meanline location.
Type

Quantity

Read Only

BetaLEshr
This property reports the relative flow angle at the impeller leading edge shroud location.
Type

Quantity

Read Only

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:
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

617

TurboSystems
mm
cm
inches
ft
m
Type

BMunitsType

Read Only

ChkRatio
This property reports the impeller choke ratio.
Type

float

Read Only

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

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

ClearRatio
This property reports the axial tip clearance ratio of the impeller.
Type

float

Read Only

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

618

float

Read Only

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

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

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

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

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'.

619

TurboSystems
Type

double

Read Only

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

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

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

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

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'.

620

Type

double

Read Only

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 MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.
Type

float

Read Only

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 MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.
Type

float

Read Only

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

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

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'.

621

TurboSystems
Type

double

Read Only

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

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

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

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

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'.

622

Type

double

Read Only

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 MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.
Type

float

Read Only

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

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

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

D3Hub
This property specifies the hub inlet diameter for the impeller.
Type

Quantity

Read Only

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

623

TurboSystems
Read Only

D5
This property reports the diameter at the impeller trailing edge (tip diameter).
Type

Quantity

Read Only

Diffuser
This property specifies whether the diffuser section is vaned or vaneless.
Available options:
Vaned
Vaneless
Type

DiffuserType

Read Only

string

Read Only

DLEhub
This property reports the diameter at the impeller leading edge hub location.
Type

Quantity

Read Only

DLErms
This property reports the diameter at the impeller leading edge meanline location.
Type

Quantity

Read Only

DLEshr
This property reports the diameter at the impeller leading edge shroud location.
Type

Quantity

Read Only

624

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

EtaIsen
This property reports the isentropic efficiency for the compressor stage.
Type

float

Read Only

EtaIsenImp
This property reports the isentropic efficiency for the compressor impeller.
Type

float

Read Only

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

EtaIsenUser
This property specifies the user defined stage isentropic efficiency. Note that this is only available when
the UserEfficiencyOption is set to 'Isentropic'.
Type

float

Read Only

EtaPoly
This property reports the polytropic efficiency for the compressor stage.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

625

TurboSystems
Type

float

Read Only

EtaPolyImp
This property reports the polytropic efficiency for the compressor impeller.
Type

float

Read Only

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

Gamma
This property reports the ratio of specific heats of the working fluid.
Type

float

Read Only

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

GasModelOption
This property specifies whether to treat the working fluid as an Ideal or a Real gas.
Available options:
Ideal
Real
Type

GasModelType

Read Only

GeometryStyle
This property specifies the approach taken when creating a new Geometry model from a successful
VistaCCD calculation.

626

Available options:
Interactive
Parametric
Type

GeometryStyleType

Read Only

H05
This property reports the total enthalpy at the impeller trailing edge.
Type

Quantity

Read Only

H0LE
This property reports the stagnation enthalpy at the impeller leading edge.
Type

Quantity

Read Only

Impeller
This property specifies whether the impeller is unshrouded or shrouded.
Available options:
Unshrouded
Shrouded
Type

ImpellerType

Read Only

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

Read Only

ImpellerLength
This property specifies the impeller axial length to tip diameter ratio.

627

TurboSystems
Type

float

Read Only

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

ImpellerLengthUserOpt
This property specifies whether the impeller axial length ratio will be defined by the user.
Type

bool

Read Only

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

IncLEhub
This property reports the impeller incidence at the hub location.
Type

Quantity

Read Only

IncLErms
This property reports the impeller incidence at the meanline location.
Type

Quantity

Read Only

628

IncLEshr
This property reports the impeller incidence at the shroud location.
Type

Quantity

Read Only

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

LEInclination
This property reports the leading edge angle of inclination in the meridional plane.
Type

Quantity

Read Only

LEInclinationUser
This property specifies the inclination of the leading edge relative to a radial line in the meridional view.
Type

Quantity

Read Only

Loading
This property reports the impeller loading parameter (delH/U^2).
Type

float

Read Only

M5rms
This property reports the absolute Mach number at the impeller trailing edge.
Type

float

Read Only

MachU5
This property reports the blade Mach number at the impeller trailing edge (tip Mach number).
Type

float

Read Only

629

TurboSystems

MassFlow
This property specifies the design point mass flow rate passing through the compressor stage.
Type

Quantity

Read Only

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

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

630

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

MrelLEhub
This property reports the relative Mach number at the impeller leading edge hub location.
Type

float

Read Only

MrelLErms
This property reports the relative Mach number at the impeller leading edge meanline location.
Type

float

Read Only

MrelLEshr
This property reports the relative Mach number at the impeller leading edge shroud location.
Type

float

Read Only

MrmsLE
This property reports the absolute Mach number at the impeller leading edge meanline location.
Type

float

Read Only

Mu
This property reports the dynamic viscosity of the working fluid.
Type

Quantity

Read Only

MuUser
This property specifies the dynamic viscosity of the working fluid.
Type

Quantity

631

TurboSystems
Read Only

NMain
This property specifies the number of impeller main vanes.
Type

int

Read Only

NormalToHubLE
This property specifies that the main impeller blade leading is normal to the hub curve
Type

bool

Read Only

Ns
This property reports the specific speed of the impeller.
Type

float

Read Only

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

Nu
This property reports the kinematic viscosity of the working fluid.
Type

Quantity

Read Only

NuUser
This property specifies the kinematic viscosity of the working fluid.
Type

Quantity

Read Only

Omega
This property specifies the design point rotational speed of the impeller.
Type

632

Read Only

P05rms
This property reports the total pressure at the impeller trailing edge.
Type

Quantity

Read Only

P5rms
This property reports the static pressure at the impeller trailing edge.
Type

Quantity

Read Only

PIF
This property reports the power input factor of the compressor.
Type

float

Read Only

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

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

Power
This property reports the impeller power.
Type

Quantity

Read Only

633

TurboSystems

PressureRatio
This property specifies the design point total-to-total pressure ratio for the compressor stage.
Type

float

Read Only

PreswirlOption
This property specifies how the radial distribution of the preswirl angle is calculated.
Available options:
constant
free
forced
linear
Type

PreswirlType

Read Only

RakeAngle
This property specifies the impeller rake angle (trailing edge lean angle).
Type

Quantity

Read Only

Reb5
This property reports the Reynolds number based on the impeller tip width dimension.
Type

float

Read Only

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

Red5
This property reports the Reynolds number based on the impeller tip diameter dimension.
Type

float

Read Only

634

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

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

RGas
This property reports the specific gas constant of the working fluid.
Type

Quantity

Read Only

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

S5
This property reports the specific entropy at the impeller trailing edge.
Type

Quantity

Read Only

ShrLELoc
This property specifies the main impeller blade leading edge location on the shroud
Type

float

Read Only

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-

635

TurboSystems
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

SLE
This property reports the specific entropy at the impeller leading edge.
Type

Quantity

Read Only

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

StagPressure
This property specifies the design point stagnation pressure at the inlet to the compressor stage.
Type

Quantity

Read Only

StagTemp
This property specifies the design point stagnation temperature at the inlet to the compressor stage.
Type

Quantity

Read Only

636

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

SzrFlowCoeff
This property reports the impeller flow coefficient.
Type

float

Read Only

T05rms
This property reports the total temperature at the impeller trailing edge.
Type

Quantity

Read Only

ThkHub
This property specifies the hub vane normal thickness.
Type

Quantity

Read Only

ThkShr
This property specifies the shroud vane normal thickness.
Type

Quantity

Read Only

ThroatAreaLE
This property reports the throat area at the impeller leading edge.
Type

Quantity

Read Only

637

TurboSystems

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

U5
This property reports the blade speed at the impeller trailing edge (tip speed).
Type

Quantity

Read Only

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

V5rms
This property reports the absolute velocity at the impeller trailing edge.
Type

Quantity

Read Only

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

638

ViscosityOptionR145
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

VmLEhub
This property reports the meridional velocity at the impeller leading edge hub location.
Type

Quantity

Read Only

VmLErms
This property reports the meridional velocity at the impeller leading edge meanline location.
Type

Quantity

Read Only

VmLEshr
This property reports the meridional velocity at the impeller leading edge shroud location.
Type

Quantity

Read Only

VmRatioLE
This property reports the ratio of the shroud meridional velocity to the RMS meridional velocity at the
leading edge.
Type

float

Read Only

VrmsLE
This property reports the absolute velocity at the impeller leading edge meanline location.
Type

Quantity

Read Only

639

TurboSystems

VwLEhub
This property reports the tangential velocity at the impeller leading edge hub location.
Type

Quantity

Read Only

VwLErms
This property reports the tangential velocity at the impeller leading edge meanline location.
Type

Quantity

Read Only

VwLEshr
This property reports the tangential velocity at the impeller leading edge shroud location.
Type

Quantity

Read Only

VwRatioLE
This property reports the ratio of the shroud swirl velocity to the RMS swirl velocity at the leading edge.
Type

float

Read Only

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

W5rms
This property reports the relative velocity at the impeller trailing edge.
Type

Quantity

Read Only

640

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.
Reference to the requested Data Entity

Return

Type

DataReference

Data Entities
VistaCCMBladeDesign
Setup represents a VistaCCM project definition.

Properties
Alpha3
Inlet angle
Type

Quantity

Read Only

B5
User input: impeller tip width
Type

Quantity

Read Only

BetaBlade5
User input: impeller blade exit angle
Type

Quantity

Read Only

641

TurboSystems

BetaBladeLEhub
User input: hub vane angle at the leading edge
Type

Quantity

Read Only

BetaBladeLEshr
User input: shroud vane angle at the leading edge
Type

Quantity

Read Only

ConditionsFromUpstream
Flag to choose whether to update operating conditions from upstream cell or not
Type

bool

Read Only

D5
User input: impeller exit diameter
Type

Quantity

Read Only

string

Read Only

DLEhub
User input: Hub diameter at the leading edge
Type

Quantity

Read Only

DLEshr
User input: shroud diameter at the leading edge
Type

Quantity

Read Only

642

EffPolyData
Results data: Range of polytropic efficiencies
Type

List<List<float>>

Read Only

EtaPoly
Polytropic efficiency
Type

float

Read Only

GammaUser
Ratio of specific heats
Type

float

Read Only

GasModel
Gas model
Type

int

Read Only

ImperialUnits
User input, Imperial units option
Type

bool

Read Only

KDiff
User input: Diffuser type (-1.0 = vaneless, 1.0 = vaned)
Type

float

Read Only

KType
User input: Machine type (-1.0 = process, 1.0 = turbocharger)
Type

float

Read Only

643

TurboSystems

ListSpeed
Results data: Range of speeds
Type

List<float>

Read Only

Loading
Work factor
Type

float

Read Only

MachU5
Tip Mach number
Type

float

Read Only

MassFlow
Design point mass flow rate
Type

Quantity

Read Only

MassFlowData
Results data: Range of mass flow rates
Type

List<List<float>>

Read Only

NMain
User input: number of main vanes
Type

int

Read Only

NSpeeds
User input, number of speeds
Type

int

Read Only

644

NSplit
User input: number of splitter vanes
Type

int

Read Only

PIF
Power input factor
Type

float

Read Only

PresRatioData
Results data: Range of pressure ratios
Type

List<List<float>>

Read Only

PressureRatio
Design point pressure ratio
Type

float

Read Only

RUser
Gas constant
Type

Quantity

Read Only

SIunits
User input, SI units option
Type

bool

Read Only

SpeedMax
User input, maximum speed
Type

Quantity

Read Only

645

TurboSystems

SpeedMaxFixed
User input, maximum speed
Type

Quantity

Read Only

SpeedMin
User input, minimum speed
Type

Quantity

Read Only

SpeedMinFixed
User input, minimum speed
Type

Quantity

Read Only

StagPressure
Inlet stagnation pressure
Type

Quantity

Read Only

StagPressureFixed
Inlet stagnation pressure
Type

Quantity

Read Only

StagTemp
Inlet stagnation temperature
Type

Quantity

Read Only

StagTempFixed
Inlet stagnation temperature
Type

Quantity

Read Only

646

SzrFlowCoeff
Flow coefficient
Type

float

Read Only

ThkHub
User input: Hub vane normal thickness
Type

Quantity

Read Only

ThkShr
User input: shroud vane normal thickness
Type

Quantity

Read Only

ThroatArea
User input: throat area
Type

Quantity

Read Only

TipMachInData
Results data: Range of inlet tip Mach numbers
Type

List<List<float>>

Read Only

TipMachOutData
Results data: Range of outlet tip Mach numbers
Type

List<List<float>>

Read Only

VistaCCMTitle
Editor Title
Type

string

Read Only

647

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.
Optional Arguments
Beta

Option to use the beta BladeGen template

Type

bool

Default Value

False

CreateGeometry
This command class creates a new BladeEditor model. An up-to-date Geometry cell appears on the
project schematic containing the new model.

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

648

Reference to the requested Data Entity

Type

DataReference

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

AreaDiff
This property reports the volute diffuser exit area.
Type

Quantity

Read Only

Yes

649

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

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

650

Quantity

Read Only

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

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

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 tangential direction.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

651

TurboSystems
Type

Quantity

Read Only

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

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

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

652

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

653

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 automatically, from a specified head coefficient or the value may be user defined.
Available options:
Automatic
HeadCoeff
User
Type

TipDiamType

Read Only

D2User
This property specifies the impeller tip diameter. This is valid when the D2Opt is set to 'User'.
Type

Quantity

Read Only

DEye
This property reports the impeller shroud diameter at the eye of the impeller.
Type

Quantity

Read Only

Yes

654

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

DiffRatio
This property reports the diffusion ratio of the impeller.
Type

float

Read Only

Yes

string

Read Only

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

655

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

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

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

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

656

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

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

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

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

657

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

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

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'.

658

Type

float

Read Only

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

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

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

659

TurboSystems

NumVanes
This property specifies the number of impeller vanes.
Type

int

Read Only

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

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

660

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

Rho
This property specifies the density of the working fluid.
Type

Quantity

Read Only

RMajor
This property reports a list of the major radii of the elliptic volute cross sections. This is valid when VoluteStyleOpt 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 VoluteStyleOpt 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

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 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

661

TurboSystems
Available options:
Incidence
User
Type

ShrLEBetaType

Read Only

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

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

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

662

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

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

663

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

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

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

VolFlow
This property specifies the design point volume flow rate delivered by the pump.

664

Type

Quantity

Read Only

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

VolWidth
This property reports a list of the width of the rectangular volute cross sections. This is valid when VoluteStyleOpt is 'Rectangular'.
Type

List<Quantity>

Read Only

Yes

W1
This property reports the relative flow velocity at the impeller leading edge meanline section.
Type

665

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.
Optional Arguments
Beta

Option to use the beta BladeGen template

Type

bool

Default Value

False

CreateGeometry
This command class creates a new BladeEditor model. An up-to-date Geometry cell appears on the
project schematic containing the new model.

666

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.
Reference to the requested Data Entity

Return

Type

DataReference

ImportBladeGen
This command imports Vista data into the Blade Design cell from an existing BladeGen file. If no appropriate 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.

667

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

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

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

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'.

668

Type

Quantity

Read Only

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

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

669

TurboSystems

CalcInletAlphaOption
When calculating the InletAngle from the NozzleArea there are 2 possible solutions, subsonic and supersonic. This property specifies whether to use a subsonic (LowSpeed) inlet Mach number, or a supersonic (HighSpeed) inlet Mach number.
Available options:
LowSpeed
HighSpeed
Type

CalcType

Read Only

ClearanceType

Read Only

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 calculation 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

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

670

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

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

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

671

TurboSystems

DiameterRatio
This property reports the ratio of the impeller inlet diameter to the meanline exit diameter.
Type

float

Read Only

Yes

string

Read Only

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

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()

672

bladeDesign1 = system1.GetContainer(ComponentName="Blade Design")

vistaRTDProperties1 = bladeDesign1.GetVistaRTDBladeDesignProperties()
vistaRTDProperties1.EtaOption = "Correlation"

Type

EtaType

Read Only

EtaStageTS
This property reports the total-to-static stage efficiency.
Type

float

Read Only

Yes

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

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

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:

673

TurboSystems
Absolute
Relative
Type

ExitAngleType

Read Only

ExpRatio
This property specifies the design point total-to-total expansion ratio, P01/P03, for the turbine stage.
Type

float

Read Only

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
674

Read Only

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

ImpellerLength
This property reports the ratio of the impeller axial length to the impeller tip diameter.
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

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

ImpellerLengthUserOpt
This property specifies whether the impeller axial length ratio will be defined by the user.
Type

bool

Read Only

ImpellerNumber
This property specifies the number of impeller vanes.
Type

int

675

TurboSystems
Read Only

ImpellerThickness
This property specifies the average vane thickesses at the impeller exit.
Type

Quantity

Read Only

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.
Type

float

Read Only

Yes

InletAngle
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'. Note that this is not available when the InletOption is
set to 'Calculated'.
Type

Quantity

Read Only

InletOption
This property specifies the InletAngle type. If this is set to 'Calculated' then the InletAngle is calculated
from the NozzleArea. If, in addition, ZeroBetaInlet is set, then CalcInletAlphaOption must also be specified.
Available options:
Absolute
Relative
Calculated
Type

InletAngleType

Read Only

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.

676

Type

float

Read Only

Yes

Mach2
This property reports the absolute Mach number at the impeller inlet.
Type

float

Read Only

Yes

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

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.

677

TurboSystems
Type

float

Read Only

Yes

NozExitDiameter
This property reports the nozzle exit diameter.
Type

Quantity

Read Only

Yes

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

NozzleArea
This property specifies the flow area of the nozzle at the throat. This is used to determine the impeller
inlet flow angle when the 'Calculated' option is used for the InletOption.
Type

Quantity

Read Only

NozzleNumber
This property specifies the number of nozzle vanes.
Type

int

Read Only

NozzleThickness
This property specifies the average vane thickesses at the nozzle throat.
Type

Quantity

Read Only

678

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

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

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

679

TurboSystems

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

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

Read Only

SpanwiseDistributionOption
This property specifies the spanwise distribution used when exporting the impeller blade.
Available options:
General
Radial
Type

SpanwiseDistributionType

Read Only

680

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-tototal isentropic temperature drop.
Type

float

Read Only

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

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

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

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

681

TurboSystems
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)
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

682

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-tostatic isentropic temperature drop.
Type

float

Read Only

Yes

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

683

TurboSystems
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

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.
A reference to the requested data entity.

Return

Type

DataReference

TurboSystems

Properties
Acentric
User input, acentric factor
Type

float

Read Only

ConditionsFromUpstream
Flag to choose whether to update operating conditions from upstream cell or not
Type

bool

Read Only

CpCoeff
User input: Cp expression coefficients
Type

List<double>

Read Only

CpGas
Specifies the gas specific heat at constant pressure when FluidOption = IdealGas.
Type

Quantity

Read Only

CpMax
User input: Cp expression, max temperature
Type

float

Read Only

CpMin
User input: Cp expression, min temperature
Type

float

Read Only

CriticalPressure
User input, critical pressure
Type

686

Quantity

Read Only

CriticalTemp
User input, critical temperature
Type

Quantity

Read Only

CriticalVol
User input, critical volume
Type

Quantity

Read Only

CustomRealGasFilename
The filename for the specified custom real gas file. Only used where the custom real gas option is specified.
Type

string

Read Only

CwFluid
Specifies the liquid specific heat when FluidOption = Liquid.
Type

Quantity

Read Only

string

Read Only

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.

687

TurboSystems
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

FlowOption
Specifies the types of boundary conditions.
Available options:
MassFlow
PressureRatio

PressureDifference

Type

FlowType

Read Only

Specify the mass flow rate and the inlet total

pressure and total temperature conditions.
Specify the estimated mass flow rate and the
total to static pressure ratio on the mean
streamline.
Specify the estimated mass flow rate and the
total to static pressure difference on the mean
streamline.

FluidOption
Specifies the type of fluid.
Available options:
IdealGas

For compressible flows with ideal gas properties.

For compressible flow with real gas properties
For incompressible flows.

RealGas
Liquid
Type

FluidType

Read Only

GammaGas
Specifies the gas specific heat ratio when FluidOption = IdealGas.
Type

float

Read Only

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

688

the description for cm_start in Specification of the Control Data File (*.con) in the Vista TF Reference
Guide.
Type

float

Read Only

InletPt
Specifies the inlet total pressure.
Type

Quantity

Read Only

InletSwirlAngle
Specifies the inlet swirl angle, which is from the axial direction and positive in the direction of rotation.
Type

Quantity

Read Only

InletTt
Specifies the inlet total temperature.
Type

Quantity

Read Only

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.
Available options:
Pump
AxialCompressor
CentrifugalCompressor
Fan
AxialTurbine
RadialTurbine
HydraulicTurbine
Other
Unknown
Type

MachineType

Read Only

689

TurboSystems

MassFlow
Specifies the mass flow rate when FlowOption = MassFlow or the estimated mass flow rate when FlowOption = PressureRatio or PressureDifference.
Type

Quantity

Read Only

MaxIterations
Specifies the number of calculating streamlines used in the solver.
Type

int

Read Only

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

NumStreamlines
Specifies the number of calculating streamlines used in the solver.
Type

int

Read Only

PolytropicEfficiency
Specifies the small scale polytropic efficiency for the machine, and is used to calculate the losses.
Type

float

Read Only

PressureDifference
Specifies the total to static pressure difference on the mean streamline when FlowOption = PressureDifference.
Type

Quantity

Read Only

PressureRatio
Specifies the total to static pressure ratio on the mean streamline when FlowOption = PressureRatio.

690

Type

float

Read Only

RealGasOption
Specifies which real gas is used
Type

RealGas

Read Only

RefDiameter
Specifies the reference diameter for the definition of the flow coefficient.
Type

Quantity

Read Only

RGas
User input, specific gas constant
Type

Quantity

Read Only

RhoFluid
Specifies the fluid density when FluidOption = Liquid.
Type

Quantity

Read Only

RotationalDirection
Specifies the positive direction of machine rotation about the Z-axis.
Available options:
RightHanded
LeftHanded

Positive rotation is clockwise about the Z-axis.

Positive rotation is counterclockwise about
the Z-axis.

Type

RotationType

Read Only

RotationalSpeed
The specified machine rotational speed.
Type

Quantity

691

TurboSystems
Read Only

Vista TF Solution
This container holds Solution data for an instance of Vista TF.

Data Entities
VistaTFSolution
This data entity has no user modifiable properties.

string

Read Only

692

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.

string

Read Only

IsSuppressed
True if this quantity is suppressed in the unit system.
Type

bool

Read Only

QuantityName
The name of the quantity.
Type

string

Read Only

Unit
The unit for the quantity.
Type

string

Read Only

693

Units

UnitSystem
Holds the definition of a unit system within the project.

string

Read Only

IsDefault
True if this is the current default unit system.
Type

bool

Read Only

IsProjectUnitSystem
True if this is the current project unit system.
Type

bool

Read Only

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
694

The full path and name of the file to be created.

Type

string

695

696

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 associated 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

System

EDesignPointScope

The system whose associated design (and project) is to be analyzed/solved.

Type

DataReference

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.
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.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

697

Namespaced Commands
Type
System

EDesignPointScope

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()"
The IDispatch wrapper representing the design script/IDispatch object.

Return

Type

Object

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

698

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.
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.

Return

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
Required Arguments
System

The system from which all design/project variables values will be synchronized to corresponding
ones in the editor design.
Type

DataReference

699

Namespaced Commands

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 connection's credential (userName plus password) is saved during WB GUI mode. The only required parameter 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

Port

Specify if it's an Individual Server

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
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

Type

bool

Default Value

False

Whether to include files imported to the project from external locations.

Type

702

string

GetExclusiveControl

Access Control

IncludeExternalFiles

Type

bool

Default Value

False

Include result files

IncludeResultFiles

Type

bool

Default Value

True

Include result files

PlaceUnderVersionControl

Type

bool

Default Value

True

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

Optional Arguments
Checkin

Checkin option if applicable

Type

bool

Default Value

False

703

Namespaced Commands
CheckOut

CheckOut option if applicable

Comments

Type

bool

Default Value

False

Comments
Type

IncludeExternalFiles

string

Include result files

IncludeResultFiles

Type

bool

Default Value

True

Include result files

ReleaseExclusiveControl

Type

bool

Default Value

True

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
(CheckinOption : a value greater than zero will issue a checkin. A value of 2 will check out the project
after a successful 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.

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

704

Local file path for the archived project file to be save to repository

Type
RepositoryFolderPath

string

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

Description

Type

bool

Default Value

False

Whether to include files imported to the project from external locations.

Type

GetExclusiveControl

string

Access Control

PlaceUnderVersionControl

Type

bool

Default Value

False

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_projec
GetExclusiveControl=True,
PlaceUnderVersionControl=True,
CheckOut=True,
Comments="These are my comments for this update.")

EngData
This namespace holds top-level commands and queries related to Engineering Data.

CreateLibrary
Creates a new Engineering Data library.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

705

Namespaced Commands
The created Engineering Data library.

Return

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.
The DataContainerReference for the library that was opened.

Return

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")

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 "ForceInstall" to true.
Required Arguments
ExtensionFileName

ExtensionFileName argument containing the file name of the extension.

Type

706

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",ForceIns

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

Version

string

Version argument containing the version of the extension.

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

707

Namespaced Commands
Optional Arguments
ForceUninstall

Indicates whether the extension will be uninstalled silently.

Format

Type

bool

Default Value

False

Format argument containing the format of the extension (Scripted or Binary).

Type

Version

string

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).

Type

Version

string

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")

708

Graphics
This namespace holds top-level commands and queries related to Graphics.

GetAxisContinuous
A query to return an AxisContinuous data reference.
A reference to the AxisContinuous data entity.

Return

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.
A reference to the AxisDiscrete data entity.

Return

Type

DataReference

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.
A reference to the ChartXY data entity.

Return

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

709

Namespaced Commands
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.
A reference to the CorrelationMatrix data entity.

Return

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.
A reference to the Legend data entity.

Return

Type

DataReference

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.
A reference to the MultiAxisChart data entity.

Return

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

710

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.
A reference to the RenderStyle data entity.

Return

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.
A reference to the Variable data entity.

Return

Type

DataReference

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.
A reference to the VariableXY data entity.

Return

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

711

Namespaced Commands
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
A reference to the LegacyDataBaseResumeData object that contains information about the imported database

Return

Type

DataReference

Required Arguments
FilePath

Path to legacy database to import.

Type

string

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.
The data references created by the import process.

Return

Type

DataReference

Required Arguments
FilePath

The file path to the legacy database to be imported.

Type

712

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

Retained

Indicates that the newly created design point will be exported.

Type

bool

Default Value

False

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)

713

Namespaced Commands

CreateParameter
Creates a parameter, optionally associated with a data entity property. The expression and visible name
for the parameters can be optionally specified.
A DataReference to the new parameter entity.

Return

Type

DataReference

Optional Arguments
DisplayText

The display text for the parameter.

Type

Entity

Type

PropertyName

DataReference

bool

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
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)",

714

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=[])
-orparameter1 = 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.
A data reference that represents the chart that is created.

Return

Type

DataReference

Optional Arguments
XAxisBottom

A data reference for the parameter that represents the bottom x-axis.
Type

XAxisTop

A data reference for the parameter that represents the top x-axis.
Type

YAxisLeft

DataReference

A data reference for the parameter that represents the left y-axis.
Type

YAxisRight

DataReference

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.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

715

Namespaced Commands

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

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")

716

GetAllDesignPoints
Returns a set of all design points in the project.
A data reference set containing all the design points.

Return

Type

DataReferenceSet

GetAllSortedDesignPoints
Returns a set of all design points, sorted by their update order in ascending, in the project.
A data reference set containing all the sorted design points.

Return

Type

DataReferenceSet

GetAllExportedDesignPoints
Retrieves a set of all exported design points.
A set of all design points.

Return

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.
A data reference set containing all the parameters.

Return

Type

DataReferenceSet

GetAllRetainedDesignPoints
Retrieves a set of all retained design points.
A set of all design points.

Return

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

717

Namespaced Commands
Default Value

True

GetDesignPoint
Returns a design point based on the name of the design point.
The design point of interest.

Return

Type

DataReference

Required Arguments
Name The name of the design point.
Type

string

GetParameter
A query to return a reference for a parameter given a name and a scope
The parameter of interest.

Return

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.
The parameter chart of interest.

Return

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.

718

The parameter chart of interest.

Return

Type

DataReference

Required Arguments
Name The name of the chart.
Type

string

IsParameterInDesignPointUpToDate
Checks whether a parameter is up to date in a design point.
True if the parameter is up to date in the design point.

Return

Type

bool

Required Arguments
DesignPoint

The design point data reference.

Type

Parameter

DataReference

The parameter data reference.

Type

DataReference

IsParameterUpToDate
Indicates whether a parameter is up to date in a design point.
Return if the parameter is up to date in the design point.

Return

Type

bool

Required Arguments
Parameter

Parameter
Type

DataReference

Optional Arguments
DesignPoint

Design point
Type

DataReference

OptimizeUpdateOrder
Optimizes Update Order of Design Points to minimize the number of modifications between two consecutives Design Points

719

Namespaced Commands

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

Parameter

string

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.

AddTableColumn
Add a column of data to a table
The index of the column which was newly added to the table

Return

Type

int

Required Arguments
Name

The String used to uniquely identify the column in this table. If the value is not
unique an error will occur.
Type

PhysicalQuantity

720

string

The physical quantity (e.g. Density, Pressure, etc.) used to verify the data has the
correct physical quantity.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Type
Table

string

The DataReference of the table to add this column of data.

Type

DataReference

Optional Arguments
Data

A List of the data for the column being added to the table.
Type

Index

List<Quantity>

The Integer index of the location for the newly added column. The default is to add the column
to the rightmost side of the table
Type

int

Example
This example illustrates adding a column of data to a table.
import clr
clr.AddReference("Ans.Core")
import Ansys.Core
tableData = []
tableData.add(Ansys.Core.Units.Quantity(1.0, "m"))
table1 = ...
table1.AddColumn(Name="MyNewColumnData", PhysicalQuantity="Length", Data=tableData, Index=3)

AddTableRow
Add a row of data to a table.
The index of the first row which was newly added to the table

Return

Type

int

Required Arguments
Table

The DataReference of the table to add this row of data..

Type

DataReference

Optional Arguments
Data

A List of the quantities for the row being added to the table
Type

Index

List<Quantity>

The Integer index of the location for the newly added row. The default is to add the row to the
end of the table.
Type

int

Example
This example illustrates adding a row of data in a table.

721

Namespaced Commands

import clr
clr.AddReference("Ans.Core")
import Ansys.Core
tableData = []
tableData.add(Ansys.Core.Units.Quantity("1"))
table1 = ...
table1.AddRow(Data=tableData, Index=3)

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.

IncludeExternalImportedFiles

IncludeSkippedFiles

IncludeUserFiles

Type

bool

Default Value

False

Whether to include files imported to the project from external locations.

Type

bool

Default Value

False

Whether to include Results and Solution files in the archive.

Type

bool

Default Value

True

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
external files imported into the project.
Archive(FilePath=r"C:\Users\AnsUser\simpleStructural.zip",
IncludeUserFiles=True,
IncludeSkippedFiles=True,
IncludeExternalImportedFiles=False,
FailIfFilesNeedRepair=False)

722

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>

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.
A reference to the created file is returned in this argument.

Return

Type

DataReference

Required Arguments
DestinationDirectoryPath

The full path to the destination directory.

Type

Overwrite

string

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

SourceFilePath

DataReference

A full path to the file to be copied.

Type

string

723

Namespaced Commands
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.
A reference to the created UnitSystem data entity.

Return

ErrorIfShared

Specifies whether to back up the file before deletion. This optional argument's default
value is true.
Type

bool

Default Value

True

bool

Default Value

False

Specifies whether to throw an exception when trying to delete a shared file if DeleteIfShared is set to false.
Type

File

bool

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.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

725

Namespaced Commands

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
Deletes a column from a table.
Required Arguments
Index

The column index to delete.

Type

Table

Object

The table from which to delete a column.

Type

DataReference

DeleteTableRow
Deletes a row from the table.
Required Arguments
Index

The row index to delete.

Type

Table

int

The table from which to delete a row.

Type

DataReference

DeleteTabularDataRow
Delete a row from a tabular data sheet.

726

Required Arguments
Index

Index of the row to delete.

Type

TabularData

int

Data Entity that can be bound to ITabularDataWrite

Type

DataReference

Optional Arguments
SheetName

Name of the sheet to access.

Type

SheetQualifiers

string

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.

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

727

Namespaced Commands
Holds the reference to the Repository file as the output value.

Return

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.
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.
The returned absolute user path name.

Return

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

728

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.
Data Reference set of Systems

Return

Type

DataReferenceSet

GetComponentTemplate
Query to return the Data Reference to the Component Template of the given name.
Component Template Data Reference.

Return

Type

DataReference

Required Arguments
Name Full name of the Component Template.
Type

string

GetCurrentRegisteredFiles
Gets the files registered with the project.
The set of data references to registered files.

Return

Type

DataReferenceSet

GetDesignPointUpdateSettings
Query to return the singleton DesignPointUpdateSettings.
DesignPointUpdateSettings Data Reference.

Return

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.
The data reference of the file whose name matches the supplied parameter.

Return

Type

DataReference

Required Arguments
Name The file reference name.
Type

729

Namespaced Commands

GetFilesForDirectory
Gets the set of data references to registered files within a directory.
The set of data references to files in the directory.

Return

Type

DataReferenceSet

Required Arguments
DirectoryPath

The full path to the directory.

Type

string

GetFileType
Returns a reference to a FileType data entity, given the data entity name of the FileType object.
The data reference to the FileType data entitity.

Return

Type

DataReference

Required Arguments
Name The data entity name of the FileType object.
Type

string

GetFrameworkBuildVersion
Get the current framework build version.
Return the framework build version.

Return

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

730

int

Required Arguments
ProjectDirectory

The full path to the project directory.

Type

ProjectName

string

The project name

Type

string

GetMessages
Returns DataReferences for all stored messages, ordered by message publication date/time with most
recent messages first.
The list of StoredMessage data entities for current messages.

Return

Type

DataReferenceSet

GetNeededLicenses
Query to return the needed licenses to update project.
Needed licenses based on previous updates, with license feature ID as
key, along with needed count.

Return

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.
The Project's persisted version (e.g, 120, 121, 130, 140, 145, ...).

Return

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).

731

Namespaced Commands
The full path of the current project file.

Return

Type

string

GetProjectTemplate
Query to return the Project Template of the given name.
Project Template Data Reference.

Return

Type

DataReference

Required Arguments
Name Full name of the Project Template.
Type

string

GetProjectUnitSystem
Gets the current unit system for the project.
A reference to the UnitSystem data entity.

Return

Type

DataReference

GetPropertyExpression
Gets the expression defining a data entity property's value.
Returns the expression that currently defines the property's value.

Return

Name of the solve manager

Type

string

GetSystem
Query to return the Data Reference to the system of the given name.
System Data Reference

Return

Type

DataReference

Required Arguments
Name Full name of the System
Type

string

GetTableData
Gets the data from the table.
A List of Strings or a List of List of Strings for the requested range.

Return

Type

List<Object>

Required Arguments
Table

The DataReference of the table to get data from.

Type

DataReference

Optional Arguments
RowRangeEnd

RowRangeStart

Ending index of row to get data from.

Type

int

Default Value

-1

Starting index of row to get data from.

Type

int

Default Value

Example
This example illustrates data retrieval from a table.
table1 = ...
tableData = table1.GetData(RowRangeStart=0, RowRangeEnd=2)

734

GetTabularData
Returns the tabular data associated with the data entity.
The returned data in scalar, list, or dictionary format.

Return

Type

Object

Required Arguments
TabularData

Data entity that has associated tabular data.

Type

DataReference

Optional Arguments
AsDictionary

ColumnMajor

EndIndex

SheetName

bool

Default Value

False

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

The end index for requesting a subset of the data (zero-based).

Type

int

Default Value

-2147483647

Specifies the sheet name when the data contains multiple sheets.
Type

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

StartIndex

Variables

string

Dictionary<string, string>

The start index for requesting a subset of the data (zero-based).

Type

int

Default Value

Names of the variables for which data is requested (string or list of strings).
Type

Object

735

Namespaced Commands
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.
A list of Teamcenter source strings.

Return

Type

List<string>

GetTemplate
Query to return a System Template reference, based on the template name and additional solver specification.
Template Data Reference.

Return

Type

List<string>

GetUserFilesDirectory
Gets the current user_files directory.
The full path to the user_files directory.

Return

Type

string

GetUserPathRoot
Gets the current user path root.
The user path root.

Return

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 ImportFileCommandName property must be non-null. Use FileTypeRepository.RegisterFileTypeTemplate or FileTypeTemplateRecord.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.

Type

string

737

Namespaced Commands
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.
A reference to the created UnitSystem data entity.

Return

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.
The return is True if the project is up to date.

Return

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 intermediate or final results.
Required Arguments
MergingProjects

738

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 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

KeepFilesInRsmProject

Type

bool

Default Value

True

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.

Overwrite

Type

bool

Default Value

True

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

SaveFirst

bool

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 RSMsolved 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 Design

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

739

Namespaced Commands
Optional Arguments
BackUp

File

Specifies whether to back up the file before the move. This optional argument's default value
is true.
Type

bool

Default Value

True

A reference to the file to be moved. A file reference can be obtained from commands and
queries like RegisterFileCommand and GetRegisteredFileQuery.
Type

FilePath

DataReference

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

740

string

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.
Holds the reference to the registered file as the output value.

Return

Type

DataReference

Optional Arguments
FilePath

A full path to the file to be registered.

Type

FileType

string

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 returned.
fileType1 = GetFileType(Name="MyFileType")
file1 = RegisterFile(FilePath=r"C:\Users\anyuser\myFile.abc",
FileType=fileType1)

RenameFile
Renames a file. Either the File argument or the FilePath argument must be specified.
Required Arguments
NewName

The new file name, excluding the directory path. To change the directory, see MoveFileCommand.
Type

string

Optional Arguments
BackUp

Specifies whether to back up the file before renaming it. This optional argument's default value
is true.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

741

Namespaced Commands

File

Type

bool

Default Value

True

A reference to the file to be renamed. A file reference can be obtained from commands and
queries like RegisterFileCommand and GetRegisteredFileQuery.
Type

FilePath

DataReference

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")

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

UnitSystemNewName

string

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.

742

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.
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.

Return

Type

DataReference

Optional Arguments
Session

If not specified, top level background UADP sessions will be resumed.

Type

DataReference

ResumeDesignPointUpdates
Resume design point updates suspended waiting for subtasks executed in background; or resume suspended 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

Overwrite

string

Whether to overwrite the project save location if it exists.

Type

bool

743

Namespaced Commands

SaveProjectArchiveToTeamcenter
Saves a project archive to Teamcenter. The project archive must be created before calling this function.
Required Arguments
ArchiveFileName

Archive file name

Type

TeamcenterUserName

Teamcenter User Name

Type

TeamcenterUserPassword

string

Teamcenter User Password

Type

string

Optional Arguments
DatasetDescription

Item description
Type

DatasetName

Dataset name. ArchiveFileName will be considered as the Dataset name,

if (ItemName and ItemRevision) or Dataset name is not specified
Type

DeleteArchiveOnExit

ItemName

Type

bool

Default Value

False

Type
ItemRevision

string

Teamcenter SSL CA Certificate File for HTTPS connections

Type
TeamcenterDiscriminator

string

Teamcenter Discriminator

TeamcenterGroup

Type

string

Default Value

ANSYSWBPlugInTC

Teamcenter Group
Type

TeamcenterLocale

string

Teamcenter Locale. eg. en_US

Type

TeamcenterRole

string

Teamcenter Role
Type

WaitForExitMillisecond

string

Type

Unit

string

The new Unit for the quantity.

Type

UnitSystemName

string

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.

Type

string

SetTableData
Sets the data in the table.

746

Required Arguments
Column

A string representation of index or string name of the column to begin setting data. The first
column has an index of 0 (zero). The column string name is case sensitive.
Type

Data

A List of Quanities which specifies the data to set at the given row and column of the table
Type

Row

List<Quantity>

The Integer index of the row of the table to begin setting data. The first row has an index of 0
(zero).
Type

Table

Object

int

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 used in a row-major or columnmajor order. The default is Row.
Type

DataOrder

Default Value

Row

Example
This example illustrates setting data in a table.
import clr
clr.AddReference("Ans.Core")
import Ansys.Core
tableData = []
tableData.add(Ansys.Core.Units.Quantity(1.0, "m"))
table1 = ...
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 "Variables".

747

Namespaced Commands
Type
Index

Dictionary<string, List<Object>>

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.

SheetName

Type

int

Default Value

Specifies the sheet name when the data contains multiple sheets.
Type

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

Values

string

Dictionary<string, string>

List of data values set in conjunction with the "Variables" parameter. This parameter
and the "Data" parameter are mutually exclusive.
Type

Variables

List<List<Object>>

Names of the variables for which data is being set. This parameter and and the "Data"
parameter are mutually exclusive.
Type

List<string>

748

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.
Required Arguments
Qualifier

The Qualifier to Set.

Type

TabularData

Data Entity that can be bound to ITabularDataWrite

Type

Value

string

DataReference

The new value.

Type

string

Optional Arguments
SheetName

The name of the tabular data sheet that contains the qualifier.
Type

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

VariableName

Dictionary<string, string>

The name of the Variable that contains the qualifier to be changed.

Type

VariableQualifiers

string

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>

749

Namespaced Commands
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
Type

string

SetUserPathRoot
Sets the current user path root. The root path facilitates portability of session journals by allowing relative 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.

Parameters

List<DataReference>

Determines the action to take when an error is encountered.

Type

UpdateErrorBehavior

Default Value

Continue

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")
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

751

Namespaced Commands
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.

752

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
AK_ALLOUT
AK_SUMOUT

Maximum Output
All Outputs
Sum of Outputs

AnalysisType
3D/2D import option

Possible Values
AnalysisType_3D
AnalysisType_2D

Import all 3D objects

Import only 2D objects (The model must be
in the x-y plane.)

AxesRangeModes
Enumeration of the Automatic Range modes for output parameters.

Possible Values
OutputParameterMinMax

ChartData

The range of the output parameter axis is determined from the minimum and maximum
of the parameter (min-max search of DPs minmax)
The range of the output parameter axis is determined by the min and max of the chart's
data.

Axis
The specification of allowed chart axes.

753

Data Types

Possible Values
None
X_Axis
Y_Axis
Z_Axis

BladeLoftType
Enumeration of the possible blade lofting directions.

Possible Values
Streamwise
Spanwise

BladeType
Blade type for export to BladeGen

Possible Values
IGV
Rotor
OGV

IGV
Rotor
OGV

BladeType
Blade type for export to BladeGen

Possible Values
IGV
Rotor
OGV

IGV
Rotor
OGV

BMunitsType
BladeGen/BladeEditor units type

Possible Values
m
cm
mm
inches
ft

Create
Create
Create
Create
Create

blade
blade
blade
blade
blade

model
model
model
model
model

in
in
in
in
in

metres
cm
mm
inches
feet

BMunitsType
BladeGen/BladeEditor units type

754

Possible Values
mm
inches

Create blade model in mm

Create blade model in inches

BodyGrouping
The body grouping property used when importing the model.

Possible Values
None

No body grouping action should be performed.

The model should be grouped by material IDs.
The model should be grouped by element
type IDs.
The model should be grouped by thickness
IDs.
The model should be grouped by component
IDs.
The body grouping property is not set.

Material
ElementType
Thickness
Components
Unknown

bool
This type represents a Boolean value. Valid values are 'True' or 'False'.

CalcType
Calculation from nozzle area type

Possible Values
HighSpeed
LowSpeed

High speed inlet velocity calculation

Low speed inlet velocity calculation

CandidatesColoringMethods
Enumeration of the Coloring methods used for Candidates chart.

Possible Values
ColoringPerPointType

ColoringPerOutputNature

The color is used to distinguish the different

types of candidate points (Starting Points,
Candidate Points, etc).
The color is used to distinguish the nature of
the output values (Response Surface or Simulation).

CasePrecision
Precision of FLUENT Session.

755

Data Types

Possible Values
Single
Double

CCDTemplateType
Enumeration for the Template Type for CCD algorithm.

Possible Values
CCD_STANDARD_TEMPLATE
CCD_ENHANCED_TEMPLATE

Standard
Enhanced

CdfPlotType
Enumeration of the available Cumulative Distribution Plot types.

Possible Values
None
Uniform
Triangular
Gauss
LogNorm
Exponential
Beta
Weibull

None
Uniform
Triangular
Normal
Lognormal
Exponential
Beta
Weibull

CentralCompositeDesignType
Enumeration of the available design types for the Central Composite Design algorithm.

Possible Values
CCDTYPE_FACE_CENT
CCDTYPE_ROT
CCDTYPE_VIF_OPT
CCDTYPE_G_OPT
CCDTYPE_AUTO

Face-Centered
Rotatable
VIF-Optimality
G-Optimality
Auto Defined

ChartAxes
The possible chart axes.

Possible Values
XAxis
YAxis
ZAxis
XTopAxis

756

X axis
Y axis
Z axis
Secondary X axis drawn at the top of the
chart.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

YRightAxis

Secondary Y axis drawn at the right of the

chart.
An axis used to sweep over an additional
parameter.

SweepAxis

ChartColoringMethods
Enumeration of the Coloring methods used for Tradeoff and Samples charts.

Possible Values
ColoringPerFront
ColoringPerSample

A different color for each Pareto fronts (several

samples have the same color).
A different color for each sample.

ChartStyle
Allowed styles of a multi-axis chart.

Possible Values
PCP
Spider

Parallel Coordinate Plot

Spider Plot

ChartType
Enumeration for the chart type.

Possible Values
ChartUnknown
ChartResponse
ChartTradeoff
ChartSamples
ChartDistributions
ChartCorrelation
ChartSpiderResponses
ChartLocalSensitivity
ChartSensitivities
ChartStatistics
ChartCorrelationScatter
ChartDesignPointsParallel
ChartDesignPointsCurves
ChartDetermination
ChartPredictedvsObserved
ChartDeterminationHistogram
ChartConvergence
ChartLocalSensitivityCurves
ChartCustom
ChartCandidates
ChartHistory
ChartConvergenceCriteria
ChartParameterRelationship

Unknown
Response
Tradeoff
Samples
Distributions
Correlation
Spider
Local Sensitivity
Sensitivities
Statistics
Correlation Scatter
Parameters Parallel
Design Points vs. Parameters
Determination Matrix
Predicted vs. Observed
Determination Histogram
Convergence
Local Sensitivity Curves
Custom Chart
Candidates
History
History
History

757

Data Types

ClearanceType
inpeller clearance type

Possible Values
Ratio
User

tip clearance specified as a ratio

tip clearance specified directly

ClearanceType
Enumeration of the tip clearance specification options.

Possible Values
None
RelativeLayer
AbsoluteLayer

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.

ComparePartsOnUpdateMethod
Compare parts on update options

Possible Values
ComparePartsMethod_None
ComparePartsMethod_Associatively

ComparePartsMethod_NonAssociatively

Do NOT compare parts on update -- default

value
Compare parts using associative mechanism,
if geometry interface is non-associative expect
failures in compare
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

758

A greater loosening of the default tolerance

ComparePartsTolerance_Normal
ComparePartsTolerance_Tight

Looser tolerance than default to allow some

wiggle room for slight deviations
Default, existing behavior

ConstraintHandlingType
Enumeration of the Constraint Handling types.

Possible Values
AsGoals
AsHardConstraints

Relaxed constraint
Strict constraint

ConstraintType
Enumeration of the possible optimization constraint types.

Possible Values
CT_NoPreference
CT_NearTarget
CT_LessThanTarget
CT_GreaterThanTarget
CT_InsideBounds

No constraint defined.
Equals target.
Less than target.
Greater than target.
Inside bounds.

CoordinateSystemType
Enumeration to specify the coordinate system type for imported data.

Possible Values
Cartesian
Cylindrical

CorrelationAutoStopType
Enumeration of the correlation Auto Stop types.

Possible Values
ExecuteAllSimulations
EnableAutoStop

Execute all Simulations.

Enable Auto Stop: execute Simulations iteratively until the process converges or the maximum number of simulation specified is
reached.

CoupledAnalysisType
The valid coupling types

759

Data Types

Possible Values
Undefined

This is internal option used to cache the user

selection of analysis type. It cannot be specified by the user.
Define the coupling by time steps
Define the coupling by time intervals
Define the coupling by frequency intervals.
The harmonic coupled analysis is not currently
supported.

General
Transient
Harmonic

DataContainerReference
A reference to a data container, similar to a DataReference referring to an entity.

DataOrder
An enum of Row or Column which indicates if the Data is used in a row-major or column-major order.
The default is Row.

Possible Values
Column
Row

Column-major
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
Scalar
VectorXY
VectorYZ
VectorXZ
VectorXYZ
VectorRA
VectorAZ
VectorRZ
VectorRAZ
VectorRI
VectorIA
VectorRIA

760

An unknown type
A scalar
A vector in x and y components
A vector in y and z components
A vector in x and z components
A vector in x, y, and z components
A vector in r and a components
A vector in a and z components
A vector in r and z components
A vector in r, a, and z components
A vector in r and i components
A vector in i and a components
A vector in r, i, and a components
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Tensor2XYZ
Tensor4XYZ
SymTensor2XYZ
SymTensor4XYZ
AntisymTensor2XYZ

A 2D tensor
A 4D Tensor
A 2D symmetric tensor
A 4D symmetric tensor
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.

DebugLevel
Debug levels for the log output. Increasing levels generates more detailed output in the log.

Possible Values
None
Level1
Level2
Level3
Level4
Level5
Default

No debug output
Level 1
Level 2
Level 3
Level 4
All Levels
Use Default Output Level

DelimiterType
Enumeration to specify the type of delimiter in imported data.

Possible Values
Comma
Semicolon
Space
Tab
UserDefined

DerivativeApproximationType
Enumeration for the derivative approximation type.

Possible Values
DA_CentralDifference
DA_ForwardDifference

Central Difference
Forward Difference

DeterminationCoefficientChartModes
Enumeration of the Determination Coefficient chart modes.

761

Data Types

Possible Values
Linear
Quadratic

Display linear determination coefficients.

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

Possible Values
Vaned
Vaneless

vaned diffuser
vaneless diffuser

DimensionsType
Enumeration to specify the dimensionality of imported data.

Possible Values
Dimension2D
Dimension3D

762

DistType
Enumeration of the supported distribution types for an input parameter.

Possible Values
Uniform
Triangular
Gauss
TruncGauss
LogNorm
Exponential
Beta
Weibull

Uniform
Triangular
Normal
Truncated Normal
Lognormal
Exponential
Beta
Weibull

DotStyles
Styles of dot symbols. Default is none

Possible Values
None
Ellipse
Rect
Diamond
Hexagon
Triangle
DTriangle
UTriangle
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
EndTime

The coupling will end at a given number of

steps
The coupling will end at a given time

763

Data Types

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

EffType
Impeller efficiency type

Possible Values
Automatic
Hydraulic

Efficiencies calculated from correlations

Hydraulic efficiency calculated. Volumetric,
mechanical and overall pump efficiencies user
defined.
Volumetric efficiency calculated. Hydraulic,
mechanical and overall pump efficiencies user
defined.
Mechanical efficiency calculated. Hydraulic,
volumetric and overall pump efficiencies user
defined.
Overall pump efficiency calculated. Hydraulic,
volumetric and mechanical efficiencies user
defined.

Volumetric

Mechanical

Pump

EngineeringDataType
Supported types of engineering data.

Possible Values
Unknown
Material
Load
BeamSection
Mixture

EtaCorrelType
Efficiency correlation type

764

Possible Values
Suhrmann
Baines

Suhrmann's correlation
Baines' correlation

EtaCorrelType
Efficiency correlation type

Possible Values
CaseyRobinson
CaseyMarty
Rodgers

Casey-Robinson correlation
Casey-Marty correlation
Rodgers correlation

EtaImpType
impeller isentropic efficiency type

Possible Values
LinkToStage
User

linked to stage efficiency

user specified efficiency

EtaType
Stage efficiency type

Possible Values
User
Correlation

User defined efficiency

Efficiency calculated from correlation

EtaType
Stage efficiency type

Possible Values
User
Correlation

User defined efficiency

Efficiency calculated from correlation

EtaUserType
User specified stage efficiency type

Possible Values
Isentropic
Polytropic

user-specified isentropic efficiency

user-specified polytropic efficiency

765

Data Types

ExcelConnectionState
Enumeration for the Excel Connection states

Possible Values
NotConnected
ConnectionAlive
ConnectionLost

The connection with Excel is not established

The connection is alive
The connection has been lost

ExecutionControlConflictOptions
Options for handling execution control conflicts on Edit

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
Relative

Absolute exit angle

Relative exit angle

ExpressionType
Specifies the possible types of parameter expression.

Possible Values
Undefined
Constant
Derived

766

An undefined(null) expression.
An expression without dependency on other
parameter.
An expression with dependency on other
parameters.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

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.

Possible Values
Mesh
Case
Data
Bc
Pdf
S2s
Flamelet
Dtrm
Udf
Udflib
UdfSource
Wave
SurfaceMonitors
VolumeMonitors
ParticleInjections
BoundaryProfile
SolutionTranscript
SchemeFile
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
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

767

Data Types
Nastran
NastranOutput
PamDaisy
Patran
PatranResults
Pda
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
FITTINGTYPE_KRIGING
FITTINGTYPE_MARS
FITTINGTYPE_NN
FITTINGTYPE_SPARSEGRID

Standard Response Surface - Full second order

Polynomials
Kriging
Non Parametric Regression
Neural Network
Sparse Grid

FlowType
Enumeration of the flow boundary condition options.

768

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

GasModelType
gas model type

Possible Values
Ideal
Real

ideal gas model

real gas model

GasPropType
Gas properties type

Possible Values
Air
AFR
Fixed

Gas props - Air

Gas props - Air/fuel ratio
Gas props - Fixed

GeometryAnalysisType
3D/2D Geometry import option

769

Data Types

Possible Values
Type3D
Type2D

Import all 3D objects

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
Parametric

Create interactive geometry

Create parametric geometry

GoalType
Enumeration of the possible optimization objective types.

Possible Values
GT_NoPreference
GT_MaximumPossible
GT_MinimumPossible
GT_SeekTarget

No objective defined.
Maximize.
Minimize.
Seek target.

GPUAccelerator
Enumeration for the graphics acceleration library to be used by the Mechanical APDL editor.

Possible Values
None
Amd
Intel
NVIDIA

HubLEBetaType
Hub and Mean LE blade angle option

770

Possible Values
Cot

Hub/Mean LE blade angle calculated using

cotangent (rel to Shroud LE beta)
Hub/Mean LE blade angle calculated using
cosine (rel to Shroud LE beta)
User defined hub and mean LE blade angles

Cos
User

ICCombustionSimulationType
Type of IC Engine Combustion simulation type.

Possible Values
ICSector
ICFullEngineFullCycle
ICFullEngineClosedValves

0 for sector
1 for full engine full cycle
2 for full engine IVC to EVO

ICIVCandEVOoption
IVC and EVO options

Possible Values
ICLiftCurv
ICIVCandEVO

0 lift curv profile

1 for IVC EVO option

ICSimulationType
Type of IC Engine Simulation.

Possible Values
ICSimulationColdFlow
ICSimulationPortFLow
ICSimulationCombustion

0 for Cold Flow Simulation

1 for Port Flow Simulation
2 for Combustion Flow Simulation

IDHandling
The ID handling property for the current object.

Possible Values
None
Automatic

Unknown

No action must be carried out when renumbering the attributes of the current object.
The IDs of the attributes of the current object
must be automatically renumbered so that no
conflicts will happen.
The ID Handling property is not set.

771

Data Types

ImpellerExportType
Impeller export type

Possible Values
Coupled
Isolated

Coupled to volute
Isolated impeller

ImpellerLengthType
impeller length ratio type

Possible Values
Automatic
User

automatic
user specified

ImpellerType
impeller type

Possible Values
Unshrouded
Shrouded

unshrouded impeller
shrouded impeller

ImportanceLevel
Enumeration of the importance levels which can be associated with an optimization objective or constraint.

Possible Values
GI_MediumImportant
GI_LowImportant
GI_HighImportant

Default
Lower
Higher

IncidenceType
Incidence type

Possible Values
incidence
choke

specified incidence
specified choke

InitializationMethods
Initilization Methods

772

Possible Values
ProgramControlled
SolverControlled
ProvideInitialSolution

InitializationOption
Enumeration for the Solution update initialization options.

Possible Values
CurrentSolutionData
InitialConditions

InitializationType
The initialization settings

Possible Values
ProgramControlled
StartTime
RestartStepTime

Program Controlled
Start Time
Restart Step and Time

InletAngleType
Inlet angle type

Possible Values
Absolute
Relative
Calculated

Absolute inlet angle

Relative inlet angle
Calculated from nozzle area

int
This type represents an Integer number.

long
This type represents a long (64-bit) Integer number.

JobRunMode
The job running modes

Possible Values
Foreground
Background

Forground mode.
Background mode.

773

Data Types
RemoteSolveManager

Submitted to Remote Solve Manager to run

the job.

KernelVariationType
Enumeration of the Kernel Variation types.

Possible Values
VARIABLE
CONSTANT

Variable
Constant

LinearCorrelationType
Enumeration of the Correlation types.

Possible Values
Spearman
Pearson

Spearman
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.

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.

774

Possible Values
MachineList
FileName

MachineType
Setup Entity enum definition for machine type

Possible Values
Pump
AxialCompressor
CentrifugalCompressor
Fan
AxialTurbine
RadialTurbine
HydraulicTurbine
Other
Unknown

MaterialNamesList
Database materials list Note that this is currently a fixed list which must correspond to the vistaFluids.xml
database

Possible Values
Air
CarbonDioxide
Hydrogen
Methane
Nitrogen
Oxygen
Parahydrogen
Propylene
R123
R125
R134a
R141b
R142b
R245fa
Water

Air
Carbon dioxide
Hydrogen
Methane
Nitrogen
Oxygen
Parahydrogen
Propylene
R123
R125
R134a
R141b
R142b
R245fa
Water

MaterialPropsType
material properties type

Possible Values
Database
User

select material from database

775

Data Types

MeshFileType
MeshFileType is used to identify the format of the mesh data file. This is usually the same as the application that generated the data file.

Possible Values
CFX
ICEM_CFD
FLUENT
POLYFLOW
Unknown

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

Possible Values
NoUpstreamMeshFile
SingleMeshFile

in this mode, no mesh file is selected from the

upstream polyflow system.
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
Warning
Error
Fatal
Problems

An informational message for the user.

A warning message for the user.
An error message for the user.
A fatal message for the user.
Problem messages (WARNING + ERROR +
FATAL).
All non-debug and non-progress messages.
A debug message.
A progress message for the user.
A news update for the user.

Standard
Debug
Progress
News

MixedImportPref
Mixed import preference option for mixed dimension parts

Possible Values
MixedImport_None
MixedImport_Solids
MixedImport_Surfaces

776

If mixed dimension part, import None

If mixed dimension part, import Solids only
If mixed dimension part, import Surfaces only

MixedImport_Lines
MixedImport_SolidsAndSurfaces
MixedImport_SurfacesAndLines

If mixed dimension part, import Lines only

If mixed dimension part, import Solids and
Surfaces only
If mixed dimension part, import Surfaces and
Lines only

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.
The model is formatted according to the CFX
standard.
The model is stored in a Meshing database.
The model is formatted according to the Fluent standard.
The model is formatted according to the Icem
standard.
The model is formatted according to the CDB
standard, used in Mechanical APDL.
The model is formatted according to the
Nastran standard.
The model is stored in a Simulation database.
The model is formatted according to the STL
standard.
The model is stored in an ACMO database.
The model is formatted according to the RST
standard, used in Mechanical APDL.
The model is formatted according to the results standard used in ABAQUS.
The model is formatted according to the results standard used in Nastran.
The model is formatted according to the results standard used in Samcef.
Internally used to specify a FE Modeler to FE
Modeler connection.
The model type property is not set.

CFX
CMDB
Fluent
Icem
MechAPDLCDB
Nastran
SimulationSetup
STL
ACMO
MechAPDLRST
AbaqusResults
NastranResults
SamcefResults
FEModeler
Unknown

MonitorChartType
MonitorChartType enum: Residual or UserDefined

Possible Values
Residual
UserDefined

777

Data Types

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

NumSampType
Enumeration to specify for the samples type for OSFD algorithm.

Possible Values
SFD_CCD
SFD_LINEAR
SFD_PUREQUAD
SFD_CROSSQUAD
SFD_USER

CCD samples
Linear model samples
Pure quadratic model samples
Full quadratic model samples
User-defined samples

NuUserType
kinematic viscosity calculation type (obsolete)

Possible Values
Sutherland

calculate viscosity from Sutherland's Law (using coeffs for air)

user specified kinematic viscosity

User

Object
This type can represent any generic object. It is used when any type is a valid value.

OpeningPositionMethod
Enumeration of the inlet/outlet placement options.

778

Possible Values
Manual
AdjacentBlade

OptimalSpaceFillingType
Enumeration of the available design types for the Optimal Space Filling algorithm.

Possible Values
SFDTYPE_MDIST
SFDTYPE_CL2
SFDTYPE_MAXENT

Max-Min Distance
Centered L2
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")
>>> 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

779

Data Types

Possible Values
None
EveryStep
StepInterval

No intermediate result files

Every Coupling Step
At defined interval

OutputSource
Source of the output values, indicating the method used to obtain them.

Possible Values
UserEdited
Simulation

The output values are edited by the user.

The output values are obtained by a real simulation.
The output values are obtained by evaluating
a response surface approximation.

ResponseSurface

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
NatureUsability

Continuous
Obsolete. Instead of defining a usability parameter, define a continuous parameter with
the UseManufacturableValues set to True.
Discrete

NatureDiscrete

ParameterRelationshipType
Enumeration of the possible parameter relationship types.

Possible Values
PRT_LessThanOrEqualTo
PRT_GreaterThanOrEqualTo

Less Than or Equal To

Greater Than or Equal To

ParameterUsage
Specifies the possible ways a parameter can be used or set within the data model.

Possible Values
Input

780

A parameter whose value will be used by the

ExpressionOutput

An output parameter whose value is based

on an expression. The parameter cannot be
associated directly with the data model.
A parameter whose value will be provided
directly by the data model. The parameter
expression has to be undefined(null).

DirectOutput

ParameterValueType
Type of a parameter value.

Possible Values
ActualValue
VariationToReference

The actual value of the parameter.

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

PIFType
power input factor type

Possible Values
Correlation
User

correlation
user specified

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

Left
Right
Above
Below

Default position. It is a new "child" of position,

by system if given, or a new "root" system
otherwise.
Positioned left to a system.
Positioned right to a system.
Positioned above a system.
Positioned below a system.

781

Data Types

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
free
forced
linear

Constant inlet angle

Free vortex
Solid body rotation
Linear variation of Vw

ProcessorUnit
Various Processore Unit options available for Microsoft Scheduler

Possible Values
Core
Socket
Node

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.

782

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.

RampingType
Enum providing ramping options.

Possible Values
None
Linear

No ramping.
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

RepositoryFileInfo
Class to specify a repository file

783

Data Types

ResponseChartModes
Enumeration of the available Response chart modes.

Possible Values
Curve2D

2D response chart where an output parameter

is plotted versus an input parameter.
3D response chart where an output parameter
is plotted versus two input parameters.
2D response chart where an output parameter
is plotted versus two input parameters, on the
X axis and the other varying over several
curves.

Surface3D
Slices2D

ResponseSurfaceRefinementType
Enumeration for the Refinement type.

Possible Values
REFINEMENT_NONE
REFINEMENT_AUTO
REFINEMENT_MANUAL

None
Automated
Manual

RotationType
Enumeration of the machine rotational direction options.

Possible Values
RightHanded
LeftHanded

RoughnessType
surface roughness type

Possible Values
Machined
Cast

machined surface finish

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
784

Other

SampleGenType
Enumeration for the Sampling type.

Possible Values
SAMPLE_GEN_LHS
SAMPLE_GEN_WLHS

LHS
WLHS

SamplesChartModes
Enumeration of the available Samples chart modes.

Possible Values
Candidates

Draw the samples and highlight the optimization candidates.

Draw the samples using colors that represent
their Pareto front.

ParetoFront

Scale
Enum to define the scale of the axis.

Possible Values
Linear
CommonLog
NaturalLog

Scale
Enum to define the scale of the axis.

Possible Values
Linear
CommonLog
NaturalLog

Linear scale
Common or log base 10 scale
Natural log scale

SchedulerSpecification
Various Job Schedulers available on Unix/Linux.

Possible Values
LSF
SGE
PBSPro

785

Data Types

SensitivityChartModes
Sensitivity chart modes.

Possible Values
BarChart
PieChart

2D Bar chart
2D Pie chart

ShrLEBetaType
Shroud LE blade angle option

Possible Values
Incidence

Shroud LE blade angle calculated from specified incidence

User defined shroud LE blade angle

User

ShroudDiameterType
shroud diameter type

Possible Values
Diameter
Angle
Optimum

user specified shroud inlet diameter

user specified shroud vane inlet angle
optimised shroud inlet diameter (minimum
Mrel)

SimulationType
Enumeration for the simulation types of a parameter.

Possible Values
DesignVariable
UncertaintyVariable

Design variable
Uncertainty variable

float
This type represents a single-precision floating point number.

SixSigmaTableTypes
Enumeration of the Probability Table types.

Possible Values
ProbabilityTable
InverseProbabilityTable

786

Quantile-percentile
Percentile-quantile

SolverRestartMode
Indicates the type of restart.

Possible Values
NoRestartFile
SingleResultFile
CombineResultRestartFiles

SingleCsvFile
CombineCsvRestartFiles

ManyResultFiles

ManyCsvFiles

In this mode, no restart file is used to initialize

time scheme and fields.
In this mode, a result file is used to initialize
fields.
In this mode, a result file is used to initialize
fields and a restart file is used to initialize time
scheme (starting time + derivates).
In this mode, a csv file is used to initialize
fields.
In this mode, a csv file is used to initialize
fields and a restart file is used to initialize time
scheme (starting time + derivates).
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).
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.

SpanwiseDistributionType
Spanwise distribution type

Possible Values
General

Blade exported using general spanwise distribution

Blade exported using radial spanwise distribution

Radial

StackingType
stacking type

Possible Values
Radial
Tan
Sin

Radial stacking
Beta calculated from tangent
Beta calculated from sin

Status
The current calculation status of the Excel file.

787

Data Types

Possible Values
UpToDate
OutOfDate

ErrorsWhenCalculating

The output parameters are up to date.

The values of the input parameters are modified and the values of the output parameters
are not recalculated yet.
Errors ocurred during the calculation in Excel.

STLSDTAlgorithm
SDT Algorithm Options

Possible Values
STLSDTAlgorithm_Curvatures
STLSDTAlgorithm_Angles

Curvature based SDT algorithm

Angle based SDT algorithm

string
This type represents a String value.

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.

TipDiamType
Impeller tip diameter option

Possible Values
Automatic

D2 calculated automatically (from stability

factor)
D2 calculated from head coefficient
D2 user defined

HeadCoeff
User

TopologyType
All of the possible values for topology.

Possible Values
Point
Curve
Surface
Volume

A
A
A
A

topological
topological
topological
topological

point
curve
surface
volume

TradeoffChartModes
Enumeration of the available Tradeoff chart modes.

788

Possible Values
Curve2D

2D tradeoff chart where a parameter is plotted

versus another parameter.
3D tradeoff chart where a parameter is plotted
versus two other parameters.

Surface3D

TransferAtType
Enum providing options of when to Transfer Data.

Possible Values
StartOfStep
StartOfIteration

Transfer data at start of step.

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.

TransformationType
Enumeration of the available transformation types applicable to an output parameter.

Possible Values
TransTypeNone
TransTypeBox
TransTypeYeo

No transformation
Box-Cox
Yeo-Johnson

TypeOfInitialSampling
Enumeration for the Initial Sampling Type.

Possible Values
E_Screening
E_OSF
E_ConstrainedSampling

Screening
Optimal Space-Filling
Constrained Sampling

uint
This type represents an unsigned integer number. Negative values are invalid.

UpdatableEntityState
Types of state an updatable entity can have.
Release 15.0 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

789

Data Types

Possible Values
Unknown
OutOfDate
UpToDate
Error
OutOfDateWithError
UpToDateWithError
RefreshRequired

entity state can not be defined.

entity is out of date.
entity is up to date.
last update of the entity gave an error.
entity is out of date and last update of the
entity gave an error.
entity is up of date and last update of the
entity gave an error.
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.
Don't do any more work on the failing design
point, but continue with the next one if any.
Update as much of the project, and as many
design points, as possible.

SkipDesignPoint
Continue

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
Expert

Default
Expert

VariableStyle
Styles that can be used to display the variable. Default is Line

790

Possible Values
None
Line
Spline
Step
Bar
Default

ViscosityType
viscosity type

Possible Values
Sutherland

Viscosity calculated using Sutherland's Law (2

coefficient method)
User-specified dynamic viscosity
User specified kinematic viscosity

Dynamic
Kinematic

VoluteType
Volute style option

Possible Values
Elliptic
Rectangular

Elliptic/circular cross sections

Rectangular cross sections

XAxisQuantity
Enum for quantity used for X-axis.

Possible Values
Iteration
FlowTime
TimeStep

YN
This is enum for yes/no option

Possible Values
ICYes
ICNo

791

792

Index
A
Ansoft data container, 37
Ansoft Feedback Iterator data container, 39
Ansoft Namespace, 697
ANSYS Workbench journaling
overview, 1
ANSYS Workbench scripting
examples, 16
APDL example, 25
data-integrated application, 25
embedded script, 25
file management, 20
material properties, 23
project updates, 16
tabular data, 23
updating from Excel, 29
file path handling, 14
object-based, 13
overview, 1
path handling, 14
units, 15
using, 13
APDL script scripting examples, 25
AQWA Model data container, 43
AQWA Results data container, 45
AQWA Setup data container, 46
AQWA Solution data container, 48
argument
scripting definition, 10
AUTODYN Analysis data container, 51
AUTODYN Setup data container, 51

C
CFD Results data container, 55
CFX Setup data container, 59
CFX Solution data container, 62
command window
journaling, 3
navigation, 4
component
scripting definition, 8
console window
journaling, 6

D
data container
scripting definition, 8, 13
data container reference
scripting definition, 9

Data Containers
Ansoft, 37
Ansoft Feedback Iterator, 39
AQWA Model, 43
AQWA Results, 45
AQWA Setup, 46
AQWA Solution, 48
AUTODYN Analysis, 51
AUTODYN Setup, 51
CFD Results, 55
CFX Setup, 59
CFX Solution, 62
DX Direct Optimization, 67
DX Evaluation Container, 110
DX GDO Design of Experiment, 179
DX GDO Response Surface, 200
DX Parameters Correlation, 232
DX Six Sigma Analysis, 249
Engineering Data, 265
Engineering Data Curve Fit, 299
Engineering Data Favorite Items, 303
Engineering Data Favorite Library, 324
External Connection, 351
External Data, 353
External Model Setup, 367
Finite Element Modeler, 375
FLUENT Setup, 385
FLUENT Solution, 398
Geometry, 415
Graphics, 425
ICE, 443
ICE Setup, 445
ICEM CFD, 449
IcePak Setup, 451
IcePak Solution, 452
Mechanical APDL, 455
Mechanical Enhanced Model, 461
Mechanical Model, 462
Mechanical Results, 471
Mechanical Setup, 472
Mechanical Solution, 475
Mesh, 481
Microsoft Office Excel Analysis, 489
Parameters, 497
Polyflow Setup, 507
Polyflow Solution, 511
Project, 515
Project File Types, 526
Project Files, 527
Project Messages, 532
System Coupling Setup, 535
System Coupling Solution, 553

793

Index
Turbo Geometry, 563
Turbo Mesh, 568
Units, 693
Vista AFD Analysis, 572
Vista AFD Design, 589
Vista AFD Meanline, 605
Vista CCD, 614
Vista CCM, 641
Vista CPD, 648
Vista RTD, 666
Vista TF Setup, 684
Vista TF Solution, 692
data entity
scripting definition, 9, 13
data reference
scripting definition, 9
Data Types, 753
data-integrated applications
scripting, 6
data-integrated applications scripting examples, 25
DX Direct Optimization data container, 67
DX Evaluation Container data container, 110
DX GDO Design of Experiment data container, 179
DX GDO Response Surface data container, 200
DX Parameters Correlation data container, 232
DX Six Sigma Analysis data container, 249

E
EKM Namespace, 700
embedded script scripting examples, 25
EngData Namespace, 705
Engineering Data Curve Fit data container, 299
Engineering Data data container, 265
Engineering Data Favorite Items data container, 303
Engineering Data Favorite Library data container, 324
Extensions Namespace, 706
External Connection data container, 351
External Data data container, 353
External Model Setup data container, 367

F
file management scripting examples, 20
file path handling
ANSYS Workbench scripting, 14
absolute/relative paths, 14
slashes, 14
Finite Element Modeler data container, 375
FLUENT Setup data container, 385
FLUENT Solution data container, 398

G
Geometry data container, 415

794

Graphics data container, 425

Graphics Namespace, 709

I
ICE data container, 443
ICE Setup data container, 445
ICEM CFD data container, 449
IcePak Setup data container, 451
IcePak Solution data container, 452
IronPython, 5

J
journaling
command window, 3
navigation, 4
shortcuts, 4
console window, 6
definition, 1, 7
overview, 1
playing a journal, 2
preferences, 1
recording, 2
uses, 1

K
keyboard shortcuts
command window, 4
Known Issues and Limitations, 33

M
material properties scripting examples, 23
Mechanical APDL data container, 455
Mechanical Enhanced Model data container, 461
Mechanical Model data container, 462
Mechanical Namespace, 712
Mechanical Results data container, 471
Mechanical Setup data container, 472
Mechanical Solution data container, 475
Mesh data container, 481
Meshing Namespace, 712
method
scripting definition, 9
Microsoft Office Excel Analysis data container, 489

N
namespaced command
scripting definition, 10
Namespaced Commands, 697
Namespaces
Ansoft, 697
EKM, 700
EngData, 705

Extensions, 706
Graphics, 709
Mechanical, 712
Meshing, 712
Parameters, 713
Project, 720

O
object
scripting definition, 9

P
Parameters data container, 497
Parameters Namespace, 713
path handling
ANSYS Workbench scripting, 14
absolute/relative paths, 14
slashes, 14
Playing a journal, 2
Polyflow Setup data container, 507
Polyflow Solution data container, 511
preferences
journaling, 1
project
scripting definition, 8
Project data container, 515
Project File Types data container, 526
Project Files data container, 527
Project Messages data container, 532
Project Namespace, 720
Project updates scripting examples, 16
property
scripting definition, 9
Python, 5

Q
query
scripting definition, 10

R
recording a journal, 2

S
scripting
definition, 5
argument, 10
component, 8
data container, 8
data container reference, 9
data entity, 9
method, 9
namespaced command, 10

object, 9
project, 8
property, 9
query, 10
system, 8
templates, 10
definitions, 7
data container, 13
data entity, 13
data reference, 9
overview, 1
SendCommands, 6
using, 13
with data-integrated applications, 6
SendCommands
using, 6
setting journaling preferences, 1
setting preferences
journaling, 1
shortcuts
command window, 4
system
scripting definition, 8
System Coupling Setup data container, 535
System Coupling Solution data container, 553

T
tabular data scripting examples, 23
templates
scripting definition, 10
Turbo Geometry data container, 563
Turbo Mesh data container, 568

U
units
ANSYS Workbench scripting, 15
Units data container, 693
updating from Excel scripting examples, 29
using ANSYS Workbench scripting, 13
using the command window
journaling, 3
navigation, 4

V
Vista AFD Analysis data container, 572
Vista AFD Design data container, 589
Vista AFD Meanline data container, 605
Vista CCD data container, 614
Vista CCM data container, 641
Vista CPD data container, 648
Vista RTD data container, 666
Vista TF Setup data container, 684

795

Index
Vista TF Solution data container, 692

796

Ansys Fluent Tutorial Guide 2025 R1
100% (2)
Ansys Fluent Tutorial Guide 2025 R1
1,394 pages
ANSYS Mechanical Users Guide
No ratings yet
ANSYS Mechanical Users Guide
2,008 pages
F
No ratings yet
F
3 pages
ANSYS Autodyn Users Manual
100% (4)
ANSYS Autodyn Users Manual
502 pages
Zoho Interview Questions
50% (2)
Zoho Interview Questions
23 pages
ANSYS Icepak Users Guide
No ratings yet
ANSYS Icepak Users Guide
1,074 pages
ANSYS Fluid Dynamics Verification Manual 18.2
No ratings yet
ANSYS Fluid Dynamics Verification Manual 18.2
252 pages
ANSYS Remote Solve Manager Users Guide 18.2
No ratings yet
ANSYS Remote Solve Manager Users Guide 18.2
176 pages
ANSYS Mechanical APDL Basic Analysis Guide
No ratings yet
ANSYS Mechanical APDL Basic Analysis Guide
364 pages
ANSYS Mechanical APDL Theory Reference 15 PDF
100% (2)
ANSYS Mechanical APDL Theory Reference 15 PDF
988 pages
ANSYS Fluent Migration Manual 18.2
No ratings yet
ANSYS Fluent Migration Manual 18.2
48 pages
ANSYS Composite PrepPost Users Guide
100% (1)
ANSYS Composite PrepPost Users Guide
370 pages
ANSYS Mechanical APDL Introductory Tutorials
100% (1)
ANSYS Mechanical APDL Introductory Tutorials
106 pages
Fluent Tips and Tricks
No ratings yet
Fluent Tips and Tricks
137 pages
ANSYS Icepak Tutorials r170
100% (2)
ANSYS Icepak Tutorials r170
826 pages
ANSYS Tutorial Design Optimization
100% (4)
ANSYS Tutorial Design Optimization
9 pages
Ansys Scripting Manual
100% (1)
Ansys Scripting Manual
388 pages
ANSYS Composite PrepPost Users Guide
No ratings yet
ANSYS Composite PrepPost Users Guide
450 pages
ACP Users Guide
No ratings yet
ACP Users Guide
574 pages
Workbench Users Guide
No ratings yet
Workbench Users Guide
436 pages
ANSYS LS-DYNA Users Guide PDF
No ratings yet
ANSYS LS-DYNA Users Guide PDF
214 pages
ANSYS Inc. Release Notes
No ratings yet
ANSYS Inc. Release Notes
138 pages
ANSYS Mechanical APDL Element Reference
88% (8)
ANSYS Mechanical APDL Element Reference
1,440 pages
ANSYS Fluent Meshing Text Command List 18.2
No ratings yet
ANSYS Fluent Meshing Text Command List 18.2
196 pages
Ansys
No ratings yet
Ansys
26 pages
Ansys Explicit Dynamics Analysis Guide
No ratings yet
Ansys Explicit Dynamics Analysis Guide
280 pages
ANSYS Mechanical APDL Contact Technology Guide
No ratings yet
ANSYS Mechanical APDL Contact Technology Guide
192 pages
ANSYS, Inc. Known Issues and Limitations 18.2
No ratings yet
ANSYS, Inc. Known Issues and Limitations 18.2
30 pages
ANSYS Mechanical APDL Connection Users Guide 18.2
No ratings yet
ANSYS Mechanical APDL Connection Users Guide 18.2
38 pages
Multizone Meshing
No ratings yet
Multizone Meshing
16 pages
Introduction To ANSYS Mechanical (2D)
No ratings yet
Introduction To ANSYS Mechanical (2D)
19 pages
Autodyn Chapter 3 Autodyn Basics
100% (2)
Autodyn Chapter 3 Autodyn Basics
32 pages
Fluent Tutorial Guide 182
100% (1)
Fluent Tutorial Guide 182
1,038 pages
ANSYS Icepak Tutorials R180 PDF
100% (2)
ANSYS Icepak Tutorials R180 PDF
896 pages
ANSYS CFD-Post User's Guide
No ratings yet
ANSYS CFD-Post User's Guide
372 pages
ANSYS Parametric Design Language Guide 18.2
No ratings yet
ANSYS Parametric Design Language Guide 18.2
110 pages
ANSYS Meshing Users Guide PDF
100% (1)
ANSYS Meshing Users Guide PDF
498 pages
ANSYS Mechanical APDL Parallel Processing Guide
100% (1)
ANSYS Mechanical APDL Parallel Processing Guide
54 pages
Ans Mat
No ratings yet
Ans Mat
206 pages
ANSYS CFD-Post Tutorials r190
No ratings yet
ANSYS CFD-Post Tutorials r190
80 pages
Workbench LS DYNA
No ratings yet
Workbench LS DYNA
16 pages
ANSYS FENSAP-ICE User Manual
No ratings yet
ANSYS FENSAP-ICE User Manual
522 pages
Ansys Fensap-Ice Tools Reference
No ratings yet
Ansys Fensap-Ice Tools Reference
40 pages
Reference - ANSYS MAPDL Command Reference
No ratings yet
Reference - ANSYS MAPDL Command Reference
2,128 pages
Explicit Dynamics Explicit Meshing
100% (1)
Explicit Dynamics Explicit Meshing
51 pages
Tutorial Worbench2 PDF
No ratings yet
Tutorial Worbench2 PDF
162 pages
User Manual of Web Plot Digitizer
100% (1)
User Manual of Web Plot Digitizer
23 pages
Ansys Fluent 2021 R1 Text Command List
No ratings yet
Ansys Fluent 2021 R1 Text Command List
536 pages
PTC Creo Parametric 3.0 for Designers
From Everand
PTC Creo Parametric 3.0 for Designers
Prof. Sham Tickoo
5/5 (1)
Programming the Finite Element Method
From Everand
Programming the Finite Element Method
I. M. Smith
No ratings yet
NX Nastran 9.0 for Designers
From Everand
NX Nastran 9.0 for Designers
Prof. Sham Tickoo
4.5/5 (2)
SolidWorks Flow Simulation 2024 Black Book
From Everand
SolidWorks Flow Simulation 2024 Black Book
Gaurav Verma
No ratings yet
Workbench Scripting Guide
No ratings yet
Workbench Scripting Guide
1,186 pages
wb2 121 PDF
No ratings yet
wb2 121 PDF
388 pages
Workbench Scripting Guide PDF
No ratings yet
Workbench Scripting Guide PDF
1,467 pages
Workbench Scripting Guide
No ratings yet
Workbench Scripting Guide
1,514 pages
Workbench Users Guide
No ratings yet
Workbench Users Guide
294 pages
Workbench Users Guide
100% (1)
Workbench Users Guide
348 pages
Workbench Users Guide 15
No ratings yet
Workbench Users Guide 15
294 pages
Workbench Users Guide v18.2 PDF
No ratings yet
Workbench Users Guide v18.2 PDF
358 pages
Workbench Users Guide PDF
No ratings yet
Workbench Users Guide PDF
342 pages
Workbench Users Guide
No ratings yet
Workbench Users Guide
316 pages
Vxrail Apresentação11
No ratings yet
Vxrail Apresentação11
15 pages
Logcat
No ratings yet
Logcat
5,351 pages
FortiClient 6.4.2 XML Reference
No ratings yet
FortiClient 6.4.2 XML Reference
106 pages
LBP V2.4 Operation DOC en
No ratings yet
LBP V2.4 Operation DOC en
146 pages
Diseño de Secuencia Power On PDF
No ratings yet
Diseño de Secuencia Power On PDF
15 pages
Ozone 11 Manual
No ratings yet
Ozone 11 Manual
199 pages
File Handling in Python
No ratings yet
File Handling in Python
9 pages
RX-V757/DSP-AX757/DSP-AX757SE RX-V657/HTR-5860: Av Receiver/Av Amplifier
No ratings yet
RX-V757/DSP-AX757/DSP-AX757SE RX-V657/HTR-5860: Av Receiver/Av Amplifier
48 pages
Site Soluton Battle 2
No ratings yet
Site Soluton Battle 2
43 pages
Presentation For Css
No ratings yet
Presentation For Css
52 pages
Devops Tutorial: The Ultimate Guide To Devops (25+ Tutorials)
No ratings yet
Devops Tutorial: The Ultimate Guide To Devops (25+ Tutorials)
1 page
Syllabus 4 Thsem
No ratings yet
Syllabus 4 Thsem
11 pages
1 Juniper - MX Series 5G Universal Routing Platforms
No ratings yet
1 Juniper - MX Series 5G Universal Routing Platforms
14 pages
Operating System Part 2
No ratings yet
Operating System Part 2
7 pages
Eaton Power Xpert Gateway UPS Card Quick Start Instructions
No ratings yet
Eaton Power Xpert Gateway UPS Card Quick Start Instructions
32 pages
BCD To Binary
No ratings yet
BCD To Binary
56 pages
C++ Part2
No ratings yet
C++ Part2
70 pages
Input Devices:: 4. Touch Screen
No ratings yet
Input Devices:: 4. Touch Screen
4 pages
Testing Vikas PDF
No ratings yet
Testing Vikas PDF
4 pages
Logicore Ip Adder/Subtracter v11.0
No ratings yet
Logicore Ip Adder/Subtracter v11.0
10 pages
4110XM Data Sheet
No ratings yet
4110XM Data Sheet
2 pages
placement and routing
No ratings yet
placement and routing
91 pages
Mbsd0 Lab Manual (Kl25z)
No ratings yet
Mbsd0 Lab Manual (Kl25z)
321 pages
Voltage Harmonics Mitigation Using DVR: Electrical & Electronics Engineering
No ratings yet
Voltage Harmonics Mitigation Using DVR: Electrical & Electronics Engineering
7 pages
ADVD-CMOS Process
No ratings yet
ADVD-CMOS Process
99 pages
Unit 1
No ratings yet
Unit 1
9 pages
03 What Is Internal Storage
No ratings yet
03 What Is Internal Storage
3 pages
Activity 3
No ratings yet
Activity 3
2 pages