Updating and Refreshing System Components

1. To save the project, from the menu bar, select File → Save.

If you choose not to save the project and any cells are configured to use RSM or run in the
background, you must change the solution process settings of those cells to run in the foreground
before you can update.

2. Right-click the required cell and select Update Upstream Components from the context menu.

Interrupting an Update Process

After starting an update, you can interrupt, or cancel the process. Be aware that not all processes can
be interrupted and some processes that are interruptible may have periods where they cannot be
interrupted. Because some processes can stop cleanly only at certain checkpoints, the delay between
the interrupt request and the actual interruption can sometimes be lengthy.

Note:

The only Ansys Mechanical systems that can be interrupted are Static Structural and
Transient Structural.

To interrupt an update process:

1. To open the Progress pane, select View → Progress from the menu bar.

2. To the right of the process you want to interrupt, click .

The following dialog box displays:

3. Select from the following options:

• Interrupt: Stops the update at the next point where data can be safely stored for later use.

• Abort: Stops the update immediately without checking if data associated with the current
action can be stored.

When an update is interrupted, the state of the Solution cell becomes Interrupted, Update Re-
quired (p. 465).

Refreshing System Components

Refreshing system components reads in all modified upstream data but does not necessarily regenerate
the outputs of the component itself. For example, if the geometry changed, placing the Mesh cell in

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 251
Updating Systems

a Refresh Required (p. 465) state, refreshing the Mesh cell updates the geometry without generating
a new mesh (which could potentially be a lengthy operation).

To refresh system components:

• To refresh all cells in the project that are in a Refresh Required state, from the menu bar select
Tools → Refresh Project, or on the Project tab toolbar click Refresh Project.

• To refresh a system, right-click the system header and select Refresh from the context menu.

• To refresh a cell, right-click the cell and select Refresh from the context menu.

Editing Shared Data

Links that are blue and drawn with a square terminator indicate that only one instance of the data exists,
and it is shared between the connected systems. In order to edit the details of that data, you must edit
the cell on the upstream system connected by these links.

In the example shown in the figure below, the Geometry cell from system A is shared with the Geometry
cell in system B, which is in turn shared with the Geometry cell of system C. To edit the geometry for
any of these systems, you must initiate the edit operation from the Geometry cell in system A. You can
either double-click the cell or right-click the cell and select Edit from the context menu.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
252 of ANSYS, Inc. and its subsidiaries and affiliates.
 Clearing Generated Data

Clearing Generated Data

Clearing generated data removes or erases any data that the cell has generated, or is prepared to
generate and store, if any such data is present. This data includes mesh, input files, solver files, and
cached solution data. This operation may alter the state of the current cell and cells downstream from
the selected cell.

Important:

For some systems, this operation results in specific behavior depending on the selected cell
and in some cases specific system data (such as existing links). Refer to the following table
for specific actions.

Cell Data Behavior Description

Mechanical systems
Model Deletes mesh, input files, and solver files. Cleans results.
Setup Deletes input and solver files. Cleans results.
Solution Deletes solver files. Cleans results. Input files (such as
ds.dat, CARep.xml) are left intact.
Results Cleans any solved results. Solver files are left intact.
Setup Imported Cleans imported load and deletes transfer xml file. User
Temperature: specifications (such as scoping) are intact.
One-way FSI
input
Setup Imported Cleans imported load and deletes transfer xml file. User
Temperature: specifications (such as scoping) are intact.
Thermal stress
Model Link to CFX Deletes SYS.cmdb.
Model Link to Deletes SYS.cdb.
Mechanical
APDL
Setup Link to No additional action required (ds.dat is the natural output
Mechanical from the Setup cell).
APDL
Solution Link to No additional action required (file.rst is the natural
Mechanical output from the Solution cell).
APDL
Mechanical APDL
Analysis Deletes Ansys-generated files (created during Update or
Edit). Files added using input links or Add xxx File are left
intact.
Fluent
Solution Internal, link to Closes the session without saving data. Deletes all files
initialization currently associated with the cell (latest available solution
data data). Any schematic input links remain intact.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 253
Updating Systems

To clear generated data:

1. Right-click the cell to clear and select Clear Generated Data from the context menu.

2. To complete the operation, click OK.

Resetting Data
Resetting data removes or erases both input and output data to the cell and sets the cell state back to
the default. Any reference files are removed.

Reset may alter the state of cells downstream from the selected cell. If you have two systems that share
cells, reset is not available from the cells that are shared, only from the source (the cell that is being
shared from).

Reset clears all solution state data and cache data for all design points in the project.

Important:

For some systems, this operation results in specific behavior depending on the selected cell
and in some cases specific system data (such as existing links). Refer to the following table
for specific actions.

Cell Data Behavior Description

Mechanical systems
Geometry Clears the geometry source and resets geometry properties to the defaults.
Model Closes the Mechanical session (if open) and deletes the .mechdb from disk.
The system is in a state as if the geometry was never attached.
Setup Deletes any objects under the Environment (such as loads and supports).
Solution Sets the values in Analysis Settings back to the defaults.
Results Deletes any results, probes, or post tools from Mechanical.
Setup Imported Deletes the Import Load from Mechanical and also deletes CFD result file
Temperature: from disk. State on Setup cell goes to Refresh Required.
One-way FSI
input
Setup Imported No additional action required.
Temperature:
Thermal stress
Model Link to CFX No additional action required.
Model Link to No additional action required.
Mechanical
APDL
Setup Link to No additional action required.
Mechanical
APDL

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
254 of ANSYS, Inc. and its subsidiaries and affiliates.
 Resetting Data

Cell Data Behavior Description

Solution Link to No additional action required.
Mechanical
APDL
Mechanical APDL
Analysis Deletes all files in the Mechanical APDL System directory and resets any
properties (as set in the Properties pane) back to the default. Any schematic
input links remain intact and the needed files are copied back into the
system upon Refresh. Any manually- added files (Add Input/Reference) are
deleted and removed from the Outline pane.
Fluent
Mesh When the Use Workflow option enabled, a Reset on the Mesh cell removes
the generated mesh (if any) and resets the workflow completely. The default
template for the workflow (specified in the Mesh cell) is then initialized and
all the workflow task states remain as Update Required. Since the workflow
state is stored in a mesh file, the mesh file is not removed, it is present and
is registered with the Mesh cell even after the Reset operation.
Setup Link to imported Closes the Fluent session without saving data. Deletes all internal files. Links
case and other to imported files are deleted (but the file is not deleted.) If Mesh is coming
input files, from an upstream simulation Mesh cell, the file is unregistered and might
settings, and get deleted if the upstream Mesh cell no longer refers to it. All associated
possibly other input parameters are deleted. Launcher settings are set to the default value.
input files
Solution Internal, link to Closes the session without saving data. Deletes all files currently associated
initialization with the cell (the latest available solution data). Any schematic input links
data remain intact. Any imported initial solution data file is unregistered. (Only
the link is removed; the file is not deleted.) All associated output parameters
are deleted. Launcher settings are set to the default values.

To reset data:

1. Right-click the cell to reset and select Reset from the context menu.

2. To complete the operation, click OK.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 255
 Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
256 of ANSYS, Inc. and its subsidiaries and affiliates.
Using Journals and Scripts
Workbench offers the ability to record the actions you perform in the user interface, also known as
journaling. Journals are recorded as Python-based scripts. You can modify these scripts or create new
ones by scripting. Together, these capabilities allow you to quickly and easily replay analyses you've
already run using recorded journals, as well as to extend functionality, automate repetitive analyses,
and run analyses in batch mode.

For detailed instructions on using journaling and scripting, as well as a complete list of all available
data containers, namespaced commands, and data types, see the Workbench Scripting Guide.

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 is automatically saved to the location you specify (see
Setting Journaling Preferences (p. 257)). You can also choose to record part of a session to a journal file,
capturing a specific set of actions. Playing back the journal recreates the recorded actions exactly.
Journaling and scripting tools (including recording and playback) are available through the scripting
menu and can be performed by anyone using Workbench. Use journaled sessions 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).

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

The creation of scripts requires a general understanding of programming constructs and paradigms.
Workbench uses an object-based approach, similar to object-oriented programming.

Related topics:
Setting Journaling Preferences
Recording a Journal
Playing Back a Recorded Journal
Using the Command Window

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 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 257
Using Journals and Scripts

To set journaling preferences:

1. From the menu bar, select Tools → Options → Journals and Logs.

2. To have Workbench automatically write journal files, select Record Journal Files.

3. Specify the default location where journal files are written.

This is the location that the browser opens to automatically when you choose to begin recording
a journal. You can also browse to a different location before saving a particular journal.

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

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

6. To save your settings, click OK.

Recording 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. 259).

To record a journal:

1. From the menu bar, select File → Scripting → Record Journal.

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

3. Use the user interface to work through your analysis as you normally would.

Note:

Not all actions are journaled—only actions that change project data. Some examples of
actions that are not journaled include:

• Interface-only actions, such as:

Interrupting a Solve operation

Launching help (including quick help and the Sidebar Help pane)
Running the View Solver Output option from VistaTF's Solution cell.

• Actions taken in some data-integrated applications; see Scripting and Data-Integrated

Applications.

4. From the menu bar, select File → Scripting → Stop Recording Journal.

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

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
258 of ANSYS, Inc. and its subsidiaries and affiliates.
 Using the Command Window

Playing Back a Recorded Journal

You can replay all of the previously recorded actions by playing back the journal file.

To play back a recorded journal:

1. From the menu bar, select File → Scripting → Run Script File.

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

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.

Note:

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.

To use the command window:

1. From the menu bar, select File → Scripting → Open Command Window.

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

As you enter each command, the appropriate action is triggered in Workbench.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 259
 Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
260 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with the Chart Pane
The Chart pane is available for Workbench applications. Applications can display data using a number
of different basic chart types. Each chart type has editable display properties.

Related topics:
Chart Types
Setting Chart Properties
Changing the Display of a 3D Chart
Using the Triad
Saving a Chart

Chart Types
Although the content of a chart will be tailored to the application that is displaying it, there are a
standard set of charts that you might see in Workbench.

XY Plot

Plots lines, points, steps, bars, splines, scatter, or shaded regions in two dimensions.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 261
Working with the Chart Pane

XYZ Plot

Plots lines, points, steps, bars, splines, scatter, or shaded regions in three dimensions.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
262 of ANSYS, Inc. and its subsidiaries and affiliates.
 Chart Types

Pie Chart

Displays variables as proportionally sized segments of a circle. If a variable to be displayed has no value,
that variable displays as a ring around the circle.

Spider Chart

Displays variables as proportionally sized segments of a circle, in multiple dimensions. Good for displaying
between three and ten variables. Can usually be displayed as a parallel coordinate plot also.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 263
Working with the Chart Pane

Parallel Coordinate Plot

Displays variables (for example, design points.) using parallel Y axes to represent all of the inputs and
outputs. Selecting an axis allows you to filter the variables shown by dragging the arrows at the ends
of the axis. Variables with points outside of the axis range are eliminated from the chart. Can usually
be displayed as a spider chart also.

Correlation Matrix

Displays how closely the various input and output parameters are coupled. The strength of correlation
is indicated by color in the matrix.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
264 of ANSYS, Inc. and its subsidiaries and affiliates.
 Setting Chart Properties

Setting Chart Properties

Each chart has properties that can be set for chart data and chart display. This section describes chart
display properties, common to charts displayed by any Workbench application. For more information
about chart data properties, refer to the help for the individual applications displaying the chart.

The various chart properties are displayed in the Properties pane (p. 460).

Note:

Only the properties that are applicable for the current chart type are displayed when you
edit a chart component (an axis, for example).

To set chart properties:

1. Right-click a part of a chart and select Edit Properties from the context menu.

• To set axis properties, right-click on, or outside of, an axis.

• To set legend properties, right-click the border or background of the legend.

• To set variable properties, right-click the variable plot on the chart or right-click the variable
name in the legend.

• To edit chart properties, right-click the background of a chart.

2. Set the required properties.

Property Description
Axis Properties
The axis properties that are available depend on whether the chart axis is discrete or continuous.
Title Sets the name for the axis (defaults to variable name).
Title Background Sets the background color used for the axis name.
Color
Show Grid • When selected, displays a grid for this chart axis

• When cleared, hides the grid

Automatic Range • When selected uses automatic scaling for the axis

• When cleared uses Range Minimum and Range Maximum for axis
scaling if they fall within the data bounds

Range Minimum Sets the minimum range of the axis and is displayed when Automatic Range
is cleared.
Range Maximum Sets the maximum range of the axis and is displayed when Automatic Range
is cleared.
Is Logarithmic • When selected, sets axis scaling to be logarithmic

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 265
Working with the Chart Pane

Property Description
• When cleared, sets axis scaling to be linear

Is Usability • When selected, displays a line/bar plot of the cross-section data in a

perpendicular direction to the axis direction

• When cleared, hides the line/bar plot

Legend Properties
Legend properties can also be set as part of general chart properties. If you click a legend variable,
the variable properties are displayed instead of the legend properties.
Visible • When selected, displays the legend for the chart

• When cleared, hides the legend for the chart

Note:

If there are too many entries in the legend, the legend does
not display, even if Visible is selected.

Style Displays the legend entries either horizontally or vertically and allows the
legend to be expanded in the same direction, if it provides any benefit
(defaults to vertical).
Foreground Color Sets the color of the legend border. The legend border default is to have no
color. You can apply a new color from the color wheel or click More and
change the Alpha channel to 0 for transparent or 255 for opaque.
Background Color Sets the color of the legend background. The legend background default is
to have no color. You can apply a new color from the color wheel or click
More and change the Alpha channel to 0 for transparent or 255 for opaque.
Variable Properties
Label Sets the name for the selected variable plot.
Is Included in When selected, adds the selected variable plot to the legend.
Legend
Display As Sets the shape for the selected variable plot.
Automatic Range • When selected uses automatic scaling for the variable values

• When cleared uses Range Minimum and Range Maximum for variable
value scaling if they fall within the data bounds

Range Minimum Sets minimum range of variable values displayed.

Range Maximum Sets maximum range of variable values displayed.
Style Display Properties
When plot rendering is controlled per variable, the style display properties appear when you
edit the variable properties. When plot line rendering is controlled generally rather than per
variable (for example, spider charts), the style display properties appear when you edit the chart
properties.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
266 of ANSYS, Inc. and its subsidiaries and affiliates.
 Setting Chart Properties

Property Description
Smoothed Edges Renders lines and surfaces with anti-aliasing set on so that the line or surface
appears to be smooth.
Line Style Sets the type of line used for the plot.
Fill Style Sets the fill style for objects in the plot that use a fill.
Line Colors Sets the color sequence for multiple lines displayed on the chart.
Fill Colors Sets the color sequence for sequential symbols or gradient used for plot
display.
Number of Color When set to 0, the gradient is displayed as a smooth graduation between
Bands values, rather than banded, where a single color is shown for a range of
values.
Relative Bar Width Sets the width of a bar as a proportion of available space [0 - 1], determined
by the maximum size bar that can be displayed without overlapping any
adjacent bars of the same variable (if other variables appear between bars
of this variable, making the bar wider may overlap those intervening variables).
Relative Bar Offset Sets the start position of a bar, proportional to the minimum point where
the bar could be placed to the maximum point where the bar could be placed
[0 - 1], with the maximum size based on the same criteria as Relative Bar
Width.
Show Linear When selected, causes the ends of a line plot to extend to the edge of
Interpolation of Lines the chart, when the plot is not against a discrete axis.

Note:

In most cases, properties are not shown if they are not

applicable to the item selected. However, Show Linear
Interpolation of Lines is displayed whether the axis is discrete
or continuous, but it only applies in cases of continuous axes.
The option will have no effect if you set it when the plot is
displayed on a discrete axis.

Symbol Outline Sets the color used to outline displayed symbols.

Colors
Symbol Size Sets the size of displayed symbols in pixels [1 - 16].
Line Width Sets the width of lines (including lines outlining bars), in pixels [1 - 10].
Chart Properties
When plot line rendering is controlled generally rather than per variable (for example, in spider
charts), the style display properties also appear when you edit the chart properties.
Title Sets the chart title that appears in the Chart pane title bar.
Chart Type Allows some charts to be displayed as another chart type.
Display Percentages Turns on percentage values on pie charts.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 267
Working with the Chart Pane

Changing the Display of a 3D Chart

You can manipulate the display of a 3D chart using the zoom, pan, and rotate features.

To change the display of a 3D chart:

• To zoom in or out of the entire chart, click the chart and use the scroll wheel or press Shift + middle
mouse button.

The chart expands or shrinks as you roll the wheel (or move the mouse) toward you or away from
you, remaining centered in the pane. The chart can be panned or rotated when it is magnified.

• To magnify a particular area of a chart, right-click and drag a box top to bottom over the area you
want to view.

The contents of the box you draw are magnified, so the smaller the box you draw, the closer the
magnification on a particular area.

• To reduce the chart to a particular size, right-click and draw a box bottom to top over the chart.

The chart zooms out to roughly correspond to the size of the box that you have drawn, so a very
small box gives you a tiny chart.

• To pan, press Ctrl + middle mouse button and move the mouse left or right.

Using the Triad

On three dimensional charts, the triad appears in the lower left corner showing the orientation of the
three axes for the current view of the chart. The x axis is red, the y axis is green, and the z axis is blue.
There is a light blue ball in the triad that indicates the orientation ISO z axis up position of the chart.
If you click this ball, it sets your chart to be ISO z axis up, fit to window.

If you move your cursor around the triad, a yellow arrow shows the direction that corresponds to the
position of your cursor (+x, -x, +y, -y, +z, -z). If you click the arrow, it changes your chart so that the
chart axis indicated by the arrow is facing out.

There are several shortcut keys that can be used when you are viewing a 3D chart:

• f – fits the chart to the window

• x – displays the x+ view, fit to window

• y – displays the y+ view, fit to window

• z – displays the z+ view, fit to window

• i – displays the chart in the ISO z axis up position, fit to window

Saving a Chart
You can save the chart that you are viewing as a graphic.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
268 of ANSYS, Inc. and its subsidiaries and affiliates.
 Saving a Chart

To save a chart:

1. Right-click the background of the chart and select Save Image As from the context menu.

2. From the Size drop-down list, select the image resolution to use when saving the chart.

3. To the right of the File field, click the ellipses .

4. In the File Name field, type a name for the image.

5. From the Save as type drop-down list, select either PNG image or BMP image.

6. To save the settings, click Save.

7. To save the image, click OK.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 269
 Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
270 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with Project Reports
Workbench project reports generate a visual snapshot of your project. The contents and organization
of the report reflect the layout of the Project Schematic, with sections for global project information,
analysis system information, system cell information, and where applicable, content provided by applic-
ations in the project.

The report contains basic project information, including:

• Export time and date

• Workbench version number

• A graphic of the systems as shown in the Project Schematic

• File information

• Parameter and design point information

• System and cell information

• Contents of notes

The specific information provided varies depending on the contents of the project.

Note:

At this time, DesignXplorer and CFD-Post are the only applications that provide the project
report with detailed report content. Content for other applications is limited to the data
visible at the project level (for example, in the Properties pane for the associated cell in the
Project Schematic).

The report is written to the user_files directory under the project directory by default.

If the project includes parameters and report content has been provided by an application in the project
during a design point update, then the design points table contains links to sub-reports for each design
point. Detailed report content for each design point can be accessed by a hyperlink in the Report
column of the design points table in the project report. Clicking the link opens a sub-report that contains
the application-specific content for that design point (if available).

Related topics:
Setting Project Report Options
Including CFD-Post Data in the Project Report
Exporting a Project Report
Editing Project Reports

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 271
Working with Project Reports

Viewing Report Images

Setting Project Report Options

You can control whether the report opens by default using the project reporting settings.

To configure project report options:

1. From the menu bar, select Tools → Options.

2. In the Options dialog, select Project Reporting from the navigation tree.

3. To launch your default browser and load the report immediately after it is generated, select the
After exporting report, automatically open in default browser check box.

If you do not select this option, you must navigate to the report file and open it manually.

4. Click OK.

Including CFD-Post Data in the Project Report

You can set whether or not to include CFD-Post data in the project report.

To include CFD-Post data:

1. In the Project Schematic, right-click the Results cell for an Ansys CFD analysis system or Results
system and select Properties.

2. In the Properties pane, select the Publish Report check box.

3. Repeat the previous two steps for each Results cell to be included in the project report.

Note:

• Only 2D content such as graphs and figures are supported in the project report. If interactive
3D content exists, it is displayed in 2D format.

• The format/style of CFD-Post reports produced from Workbench are consistent with gen-
eral Workbench-produced reports; reports from standalone CFD-Post use the standard
CFD-Post format.

Exporting a Project Report

You can export a report of the current project in .html/.htm format.

To export a project report:

1. From the menu bar, select File → Export Report.

2. To change the default file name, type a new name in the File name field.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
272 of ANSYS, Inc. and its subsidiaries and affiliates.
 Viewing Report Images

3. Click Save.

Editing Project Reports

Once you have generated a project report, you can edit its contents.

To edit a project report:

1. To open the report file with an HTML-adapted editor (such as Microsoft Word), right-click the file
and select Open with.

2. Edit the report contents and formatting as needed.

3. Save the file to a location outside Workbench.

Viewing Report Images

When you have a solved project that has design points, if a project report has been generated, you can
preview design point images from the report in the Parameter Set tab.

To view report images:

1. In the Project Schematic, right-click the Results cell and select Properties.

2. In the Properties pane, select the Publish Report check box.

3. In the toolbar, click Update All Design Points.

4. When the project has updated, click the Parameter Set bar.

5. In the Properties pane, under Design Point Report, note the list of PNG files that are available
for design points in the Report Image field.

The image files are located in the following directory:

[project_location]\dp[current_design_point]\[system_type]\Post\Report\Re-
port

6. Double-click the Parameter Set bar.

7. In the design points table, click a thumbnail in the Report Image column to open the image file.

To clear the images, in the Properties pane, set Report Image to None.

Note:

The image in the Report Image column is the default image for a CFX or Fluent report
(Generic Report Figure 1). To have a different image:

1. Set up CFD-Post to display the image you want in the report.

2. Click the Figure icon in the toolbar.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 273
Working with Project Reports

3. In the Outline pane, disable Generic Report Figure 1 and enable Figure 1.

4. In Workbench, click Update All Design Points.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
274 of ANSYS, Inc. and its subsidiaries and affiliates.
Saving and Managing Project Files
The file management system in Workbench stores several different files under a single project, using
directory trees to organize files relevant to each system and the applications used in the system.

When the project file (<filename>.wbpj) is created, Workbench creates a project folder named
<filename>_files where <filename> is a name you provide. All files relevant to the project are
saved within this folder.

The primary subdirectories within the project folder are dp0, dpall, and user_files.

We strongly recommend that you use caution when directly modifying any of the content in any of the
Workbench project directories or subdirectories other than user_files. You should work through
the Workbench user interface to manage your project as much as possible. Workbench may not recognize
or be aware of any changes that you make directly in the file system (such as adding or removing a
file).

Important:

If you are resuming a project in Mechanical on the Linux platform, there is a restriction that
the path to the project, as well as the project name, include ASCII characters only, otherwise,
the project cannot open.

Related topics:
Saving a Project File
Archiving a Project
Saving an Archive File
Exporting Systems to a New Project
Working in the Files Pane
Recovering Projects
Unlocking Project Files
Project Directories
Understanding Project File Management

Saving a Project File

To create a project file and folder, save the project.

To save the project:

1. Select one of the following options:

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 275
Saving and Managing Project Files

• To save the current project, from the menu bar, select File → Save or from the main toolbar,
click .

• To save the current project under a different name or location, from the menu bar, select File

→ Save As or from the main toolbar, click .

2. If prompted:

a. Browse to the location where you want to save the file.

Note:

Ansys recommends saving the project to a local drive rather than a network drive
due to performance reasons.

b. Type a name for the project.

c. Click Save.

Archiving a Project
If you want to send a project to a colleague or to Ansys Technical Support, or need to package all of
the files, you can archive the project.

To archive a project:

1. Optionally, specify the compression level (p. 434) for the archive file.

2. If you have imported an external file into the project, and that external file refers to other files (for
example, when a CAD assembly is linked to the CAD parts), copy the referenced files into the
user_files directory to ensure they are added to the archive.

3. To save the project, from the menu bar, select File → Save.

If you do not save the project before archiving, you are prompted to save before proceeding.

4. From the menu bar, select File → Archive.

5. In the Save Archive dialog box, navigate to the directory where you want to save the file.

Note:

The initial default save location depends on your project management (p. 434) user
preferences. Also, the location you select is remembered and used as the default location
the next time you archive a project. Review the default location carefully before saving
the archive file.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
276 of ANSYS, Inc. and its subsidiaries and affiliates.
 Saving an Archive File

6. From the Save as type list, select the archive type:

• Archive Files (*.wbpz)

• Zip File (*.zip)

7. Click Save.

8. In the Archive Options dialog box, select the optional items to archive:

• Result/solution and retained design point files

• Imported files external to project directory

• Items in the User_files folder

Note:

– If your project contains Imported Boundary Conditions in the Mechanical application,

you must include result/solution items so that the necessary upstream files are
archived. Failure to archive these files prevents you from importing data or accessing
features that involve reading upstream data, when the project is restored.

– If you are using an External Model system, select the Imported files external to
project directory option. External Model systems do not copy files to the project
folders of downstream systems.

9. Click Archive.

Saving an Archive File

On Windows systems, you can double-click .wbpz archive files from the directory they are saved in to
open the archive. If you open an archive file this way and then make changes to the project, when you
save the file you are prompted to either overwrite the archive, create a copy of the archive, or cancel
the save operation.

To save an archive file:

1. From the menu bar, select File → Save.

2. To overwrite the archive file:

a. In the dialog box, click Overwrite.

b. In the Archive Options dialog box, select the optional items to archive.

• Result/solution and retained design point files

• Imported files external to project directory

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 277
Saving and Managing Project Files

• Items in the User_files folder

Note:

If your project contains Imported Boundary Conditions in the Mechanical applic-

ation, you must include result/solution items so that the necessary upstream files
are archived. Failure to archive these files prevents you from importing data or
accessing features that involve reading upstream data, when the project is re-
stored.

c. Click Archive.

After saving, you are returned to Workbench, working in the updated archive. Use Save As
to restore the project to a .wbpj file.

3. To save a copy of the archive file:

a. In the dialog box, click Save a Copy.

b. Browse to the location to save the file.

c. Type a name for the archive copy.

d. Click Save.

After saving, you are returned to Workbench, working in the new (copy) archive. The original
archive remains unchanged. Use Save As to restore the project to a .wbpj file.

Exporting Systems to a New Project

You can reuse systems from a previously created project file by exporting one or more of them to a
new project.

Important:

To export systems, Workbench temporarily removes the systems not being exported from
the Project Schematic, saves the resulting schematic as a new project, and then restores the
original project. These systems are not being deleted, they will be restored after the export
project is saved.

Depending on how many systems are contained in the original project, and how many you
are exporting, this process can take a long time.

To create the new project:

1. If you have not saved your current project, from the menu bar, select File → Save.

2. Select all systems to be exported using one of the following methods:

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
278 of ANSYS, Inc. and its subsidiaries and affiliates.
 Exporting Systems to a New Project

• Click the header cell of a single system.

• Box-select by clicking and dragging the selection box over the required systems.

• Press Ctrl and click the required systems.

3. Right-click the header of one of the selected systems.

4. Select Export System(s) from the context menu.

5. If you did not save your project in step 1, the Unsaved Project dialog box is displayed:

a. Click Save and Proceed.

b. In the File name field, type a name for the current project.

c. Click Save.

6. In the Export As dialog box, type the name of the new export project into the File name field.

7. From the Save as type drop-down list, select .wbpj to save the export project as a new Workbench
project, or .wbpz to save the export project as an archive file.

8. Click Save.

9. If you are saving the export project as an archive file:

a. In the Archive Options dialog box, select the optional items to archive.

• Result/solution and retained design point files

• Imported files external to project directory

• Items in the User_files folder

Note:

If your project contains Imported Boundary Conditions in the Mechanical applic-

ation, you must include result/solution items so that the necessary upstream files
are archived. Failure to archive these files prevents you from importing data or
accessing features that involve reading upstream data, when the project is re-
stored.

b. Click Archive.

The export project can be opened directly, or imported into another project (p. 51).

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 279
Saving and Managing Project Files

Working in the Files Pane

The Files pane shows a list of all files associated with the project. It enables you to see the name and
type of file, the IDs of the cells the file is associated with, the size of the file, the location of the file, and
other information.

Workbench File Types

The following file types are created by the various Ansys applications and are shown in the Files pane.

Database Files
Ansys applications create the following types of database files:

• Ansys Workbench project database file (.wbpj)

• Mechanical APDL (.db)

• Fluent (.cas, .dat, and .msh)

• CFX (.cfx, .def, .res, .mdef and .mres)

• DesignModeler (.agdb)

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
280 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working in the Files Pane

• CFX-Mesh (.cmdb)

• Mechanical (.mechdb)

• Meshing (.cmdb)

• Engineering Data (.eddb)

• Mesh Morpher (.rsx)

• Ansys Autodyn (.ad)

• DesignXplorer (.dxdb)

• BladeGen (.bgd)

Workbench Journal and Log Files

Workbench writes journal and log files for each Workbench session. For more information on journal
and log file options, see Journals and Logs (p. 438).

Design Point Log Files

During a design point update, the parameter values of each successfully updated design point are
written to a CSV log file in the user_files directory. For more information, see Exporting Design
Point Parameter Values to a Comma-Separated Values File (p. 323).

Sorting and Filtering the Files List

Files added to the project appear in the Files list.

To sort and filter the files list:

1. To sort individual column data, click the arrow ( ) to the right of a column name and select
from the following options:

• To sort the column data in ascending order, select Ascending.

• To sort the column data in descending order, select Descending.

• To cancel the current sorting option, select Cancel sorting.

2. To sort multiple columns at the same time:

a. Click the arrow ( ) to the right of a column name and select Sort Settings.

b. From the Column drop-down list, select the name of the column to sort.

c. To sort the column in ascending order, leave the Ascending check box selected. To sort the
column in descending order, clear the check box.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 281
Saving and Managing Project Files

d. Repeat the previous steps until you have created a list of all of the columns you need to
sort.

To remove all of the columns from the list, click Remove All.

e. To save the changes, click OK.

3. To select the types of files that appear in the Files list:

a. Right-click any of the cells and select File Type Filter from the context menu.

b. From the Select to Display column, select or clear any check boxes to display or hide the
indicated file type.

c. To save the changes, click OK.

Repairing or Removing Deleted Files

Files missing or deleted from the project are shown in red text and are marked with a deleted icon.

You can either repair the missing files by adding them back into the project from another location,
or you can remove them from the Files list.

To repair or remove deleted files:

1. In the Files list, select a cell on the line containing the deleted file or press Ctrl and click on
multiple cells to select multiple files.

2. To repair the deleted files:

a. Right-click the selection and select Repair filename from the context menu.

b. Browse to the location where a copy of the files are stored.

c. Click Open.

The deleted files are copied into their original directory, and the name of the files are shown
in black text.

3. To remove the deleted files from the list, right-click the selection and select Remove filename
from List from the context menu.

Opening the Folder Containing Project Files

You can select a file from the Files list and open the operating system's file manager to the folder
containing that file. In most cases, you should not edit, add, or delete a file from the operating system
file manager. Workbench does not recognize or is aware of any changes that you make directly in

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
282 of ANSYS, Inc. and its subsidiaries and affiliates.
 Recovering Projects

the file system (such as adding or removing a file). However, if used with caution, this pane can be
a useful way to edit files such as application input files (for example, the Mechanical APDL application
input files).

To open the folder containing project files, right-click a cell and select Open Containing Folder from
the context menu.

Copying Cell Text

You can copy the text from one or more of the Files list cells to paste into a different program, such
as Microsoft Excel.

To copy cell text:

1. In the Files list, select the cell you want to copy the text from or press Ctrl and click multiple
cells to select them.

2. Right-click the selection and select Copy from the context menu.

Recovering Projects
Workbench creates backup files of projects that are currently active and in progress. In the event of a
crash, Workbench can use these backup files to restore your project to the last saved event.

As with any computer program, it's important that you save your work frequently to minimize data loss
in the event of a crash. Do not move or otherwise alter the backup directory.

If a project save operation fails (for example, an application is busy and cannot execute the save), you
will be given the following options:

• Revert to the last saved project.

• Make a copy of the last saved project before continuing with the partially saved project. The project
is copied into a new location that you specify.

• Exit Workbench and decide later. Use this option if you want to handle the save failure manually. As
a result, the backup directory is not cleared so that you can manually recover files from that directory
later.

• Continue with the partially saved project, discarding the last saved project (not recommended). This
option results in the backup directory being cleared. Use this option with caution, as it could result
in corrupt project files.

Note:

Recovering from a save failure occurs only when saving a previously saved file and not when
saving as a new file, or when saving the project for the first time.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 283
Saving and Managing Project Files

Unlocking Project Files

Workbench implements a project locking mechanism in order to help prevent the project from being
loaded into more than one session at a time. When the project is opened, a .lock file is created in
the project files directory. The project is unlocked by deleting the .lock file.

An improperly unlocked project can occur in situations such as program crash where the .lock file is
not deleted, or if the project files directory is duplicated and the .lock file is copied with it.

If you open a locked project, you are asked how to proceed:

• If the file is locked because of an abnormal termination, such as a program crash, click Unlock.

• If the file is locked because the project is already open in another Workbench session, click Cancel.

Opening the same project in multiple sessions can result in corrupted project files.

Project Directories
The project directory structure includes the follow folders:

• dp0 Folder (p. 284)

• dpn Subdirectories (p. 285)

• user_files Folder (p. 285)

Important:

If you are resuming a project in Mechanical on the Linux platform, there is a restriction that
the path to the project, as well as the project name, include ASCII characters only, otherwise,
the project cannot open.

dp0 Folder
Workbench designates the active project as design point 0 and creates a dp0 folder that always
corresponds to the active project files. For more information on design points, see Working with
Design Points (p. 309).

Within the folder are system folders for each system in the project. Within each system folder are
folders for each application used in the system (for example, the Mechanical application, Fluent, and
so on). These folders contain application-specific files and folders, such as input files, model directories,
engineering data, and resources. System folders for each system type are named as follows.

System Type Folder name

Autodyn ATD
BladeGen BG
Design Exploration DX
Engineering Data ENGD

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
284 of ANSYS, Inc. and its subsidiaries and affiliates.
 Project Directories

System Type Folder name

Fluid Flow (Fluent) FFF (analysis system), FLU (component system)
Fluid Flow PFL (Polyflow), PFL-BM (Blow Molding), PFL-EX (Extrusion)
(Polyflow)
Fluid Flow (CFX) CFX
Geometry Geom
optiSLang ETK
Mesh SYS (top level) / MECH (subdirectory)
Mechanical SYS (top level) / MECH (subdirectory)
Mechanical APDL APDL
System Coupling SC (top level) / SC (subdirectory) / SyC (subdirectory)
TurboGrid TS
Vista TF VTF
Icepak IPK

The Mechanical application and Mesh system folders are labeled SYS. Both the Mechanical application
and Mesh files are written to MECH subdirectories, because both are generated by Mechanical-based
applications.

In addition to the system folders, the dp0 folder also contains a global folder. This folder contains
subdirectories for all systems in the project. These subdirectories may be shared by more than one
system in the project and contain all database files, as well as any files that are associated directly
with the database files. For example, the Mechanical application writes figures, images, and contact
tool data to the appropriate system subdirectory under the global folder.

dpn Subdirectories
While a design point update is running, Workbench creates temporary design point folders. If the
Retain check box has been selected for a design point, its data is saved to a dpn subdirectory (where
dpn indicates the number of the design point) that is a sibling to the dpn folder and contains the
same sub-structure. For more information on retaining design point data, see Retaining Design Point
Data (p. 319).

user_files Folder
Under the project folder is a user_files folder. This folder contains any files (such as input files
and referenced files) that you supply to a project or any output (images, charts, movie clips, and so
on) generated by Workbench that you want to have associated with the project. In most cases, you
are responsible for placing required files into this folder. In other cases, such as the export of design
point update data from a design exploration system to a CSV log file, data is written directly to a file
created in this folder. For details, see Exporting Design Point Parameter Values to a Comma-Separated
Values File (p. 323).

Along with other project files, all of the files contained in the user_files folder appear in the Files
pane (p. 459) in Workbench.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 285
Saving and Managing Project Files

Workbench also protects this folder and ensures that it is managed and archived appropriately with
the rest of the project; therefore, you can safely store additional files (such as PowerPoint or Excel
files, or other files from separate applications that are associated with this project) here without the
risk of losing data. If you save files in any other folder in the project structure and then exit without
saving, Workbench deletes any files saved there since the last Workbench save.

Example Project
A finished project that includes a Fluid Flow (Polyflow) system (FFF), a Mechanical application system
(MECH), and parameters (DesignXplorer) might look like this:

The corresponding directory structure would look like this:

Myworkbenchproject_files
dp0
FFF
DM
Fluent
MECH
Post
global
MECH
FFF
SYS
SYS
ENGD
MECH
dpall
global
DX

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
286 of ANSYS, Inc. and its subsidiaries and affiliates.
 Understanding Project File Management

Understanding Project File Management

The project system may delete, back up, or restore files when:

• Deleting, duplicating, or replacing systems in the schematic

• Opening an application for a cell

• Closing a project without saving

• Archiving a project

• Switching to the next design point when updating all design points

While the project system is performing one of these operations, you cannot have project files open in
other applications (such as a text editor) or have the directories open in Windows Explorer. Doing so
may cause these file management operations to fail.

You cannot move a project or any of its associated files to another machine while a background run is
in progress. File information for the background run is, by necessity, machine-specific. You cannot
package or modify the background run while it is in progress.

Moving a project that has references to files outside of the project directory to a different machine or
location creates errors. By opening the project from a different machine or location, those file references
do not resolve, unless the file is still available under the same absolute path.

Copied images exist in only one location on disk that is referenced and do not exist as physical copies.
If you delete an image that has been copied, all pointers to the copies of that image will contain broken
links.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 287
 Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
288 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with Parameters and Design Points
In Ansys applications, you can define key simulation properties to be parameters. You can then manip-
ulate the parameters at the project level in Workbench to investigate design alternatives. A set of
parameter values representing one design alternative is called a design point. You can create a set of
design points in tabular form and run them automatically to perform a what-if study.

For the most part, you work with parameters and design points on the Parameters tab and the Para-
meter Set tab. However, you can also use parameters and design points in Ansys DesignXplorer for
automated design exploration studies. DesignXplorer supports the insertion of the following Design
Exploration systems from the Workbench Toolbox into the Project Schematic:

• 3D ROM

• Direct Optimization

• Parameters Correlation

• Response Surface

• Response Surface Optimization

Note:

For large parametric studies, you should use AnsysDesign Point Service (DPS), which is part
of Distributed Compute Services. DPS provides for quickly and efficiently evaluating tens of
thousands of design points using multiple compute resources. For more information, see
the DCS for Design Points Guide.

Related topics:
Parametrization Basics
Working with Parameters
Working with Design Points

Parametrization Basics
Parameters can be defined not only in Workbench applications but also in numerous external CAD
packages. Applications that allow for parametrization include the following:

• DesignModeler

• Mechanical

• Mechanical APDL

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 289
Working with Parameters and Design Points

• Fluent

• CFX

• Polyflow

• SpaceClaim

• ExplicitSTR

• CFD-Post

• Vista TF

• Meshing

• Engineering Data

• Microsoft Excel

Parameterizing CAD Dimensions

To parameterize CAD dimensions, you must first enable parameters in Workbench:

1. From the Workbench menu, select Tools → Options → Geometry Import.

2. For Filtering Prefixes and Suffixes, specify any keys that must appear at the beginning or end
of a CAD parameter name for it to display in Workbench.

The default is ANS;DS. However, you can specify any number of prefixes or suffixes as keys. For
example, to expose a CAD parameter named Length in Workbench, you could rename it to
something like dslength, Lengthds, ds_Length, or Length_ds. The order, underscore, and case
do not matter. All of these would be recognized as matching the key DS.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
290 of ANSYS, Inc. and its subsidiaries and affiliates.
 Parametrization Basics

Parameterizing Workbench Dimensions

The process for parameterizing Workbench dimensions depends on the application. The following
figures show different methods for parameterizing model data. For more information, see the docu-
mentation for the application that you are using.

Input and Output Parameters Created in DesignModeler and Mechanical

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 291
Working with Parameters and Design Points

Parameter Definition Based on a Mechanical APDL Input File

Input Parameters Created from an Expression in CFX

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
292 of ANSYS, Inc. and its subsidiaries and affiliates.
 Parametrization Basics

Input Parameter Created from an Expression in Fluent

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 293
Working with Parameters and Design Points

Output Parameters Created from an Expression in CFD-Post

Derived Parameters
Derived parameters are created using analytical expressions composed of input parameters, output
parameters, or both input and output parameters. As the definition suggests, derived parameters are
calculated from other parameters by using equations that you provide.

Some examples of derived parameters include:

• Cost Function: Product of mass and cost per mass

• Normalized Stress: Stress response divided by an applied stress

• Average Value: Average of the first three frequencies

• Mesh Sizing: Mesh parameter set as a function of a geometric parameter

Note:

Derived parameters cannot reference other derived parameters.

Defining Derived Parameters

You can define derived parameters using various built-in arithmetic, trigonometric, and statistical
functions. They are created in the analysis system and passed into DesignXplorer as output parameters.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
294 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Parameters

To create a derived parameter:

1. Double-click the Parameter Set bar to open it.

2. Enter the expression in either of these locations:

• Value field in the Outline pane

• Expression field in the Properties pane (after selecting the parameter in the Outline pane)

Note:

You can add both derived parameters and constant values in the Outline pane. However,
once derived parameters are added, they become read-only in the Outline pane. To edit
them, you must use the Properties pane.

Working with Parameters

A parameter is a numerical or other measurable factor that helps to define a particular system. A para-
meter is linked to a data model property within an application. You can have input and output para-
meters. Parameter values can be numeric or non-numeric (string or Boolean). Non-numeric parameters
are ignored for charting purposes. An input parameter can be modified at the project level and drives

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 295
Working with Parameters and Design Points

a change within the data model. The value of an output parameter is set by the application, based on
the current results or state.

Input parameters define the geometry or inputs to the analysis for the system under investigation. Input
parameters have predefined values or ranges that may be changed. These include CAD parameters,
analysis parameters, and DesignModeler parameters. CAD and DesignModeler input parameters include
length and radius. Analysis input parameters include pressure, material properties, and sheet thickness.

Output parameters result from the geometry or are the response outputs from the analysis. These include
volume, mass, frequency, stress, velocities, pressures, forces, and heat flux.

Custom Parameters are project-level parameters that are not directly associated with a data model
property. They can be a custom input or custom output parameter that is defined by a constant value,
such as 12.5 [cm] or sin(pi/2). Or, they can be a derived parameter, defined by an expression
of other parameters, such as P2+3*P3. For more information, see Expressions, Functions, Quantities,
and Units (p. 297).

All parameters have a quantity, preferably with a quantity name. The quantity name is used to define
preferred and available units for the quantity. If the value does not have a quantity name defined,
Workbench displays the value without units.

You can add parameters to or delete them from the current project. However, this may set existing
design points and design exploration systems to an out-of-date state and can result in several hours of
recalculation time, depending on the project. Be aware that deleting a parameter referenced in the
expression of another parameter invalidates the driven data model, resulting in an error.

Note:

• Negative dimension values can invert the direction vector of SpaceClaim operations with
which they are associated. This change is applied to the current and subsequent design
point updates. As a result, when a Workbench input parameter is used as a driving dimen-
sion for a SpaceClaim geometry, negative dimension values can result in unexpected
geometric changes.

• When dimensional geometry parameters are imported into Workbench from SpaceClaim
or a bi-directional CAD interface, design point updates may fail when dependencies exist
between the parameters or when the parametric update in the CAD system or SpaceClaim
cannot be realized with the parameter values specified in Workbench.

• When you define a derived parameter in the Parameter Set bar, Workbench keeps the
unit specified at the moment of its creation as the native unit. You can select Units →
Display Values as Defined to see the native unit. For example, if meter is the unit specified
when a derived parameter is created, meter is the native unit. If you want the derived
parameter to use inch as the native unit, you must specify inch before you create the
derived parameter.

Related topics:
Expressions, Functions, Quantities, and Units
Table Parameters and Design Points
Creating or Editing Parameters

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
296 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Parameters

Chaining an Output Parameter to an Input Parameter

Expressions, Functions, Quantities, and Units

The Workbench expression parser supports standard math functions and operators, as well as units
for quantities. Dimensional quantities are defined in units that are a combination of one or more
separate units.

Workbench expression and mathematical function evaluation is based on the Python 2.6 programming
language (See the Python website) and inherits some behavior as described here. All Python numeric
and function capabilities can be used. For example, Python provides support for hexadecimal (base
16) numbers. Appending a zero and an x to the front of a number tells Python to treat the number
as a hexadecimal numeric literal.

Expressions
When entering expressions, you must use the list and decimal separators defined in your locale settings.
For example, if a comma is defined as a decimal separator and a semicolon defined as a list separator,
use these when you type in an expression.

The expression defined for a custom Boolean parameter can be the Python values True or False, or
it can be a Python logical expression such as P1 > P2 or P1 == 10 and P2 == 10. For a
parameterized Boolean parameter, you can select True/False from the drop-down in the Value
column.

The expression defined for a custom string parameter must be quoted with single or double quotes,
such as ‘string value’ or "string value".

Do not start expression definitions with an = operator. Given existing parameters P1, P2, and P3 to
define a derived parameter P4 such that P4=P1*P2*P3, type the expression P1*P2*P3 in the Value
field.

When you click away from the field, the expression is solved.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 297
Working with Parameters and Design Points

Functions
Expressions support the following intrinsic functions, which support both standard numeric values
and quantities as arguments.

abs(arg) cos(arg) int2(quantity, nint2(quantity, sinh(arg)

reference) reference)
acos(arg) cosh(arg) log(arg) pow(value, exponent) sqrt(arg)
asin(arg) exp(arg) loge(arg) round(arg) tan(arg)
atan(arg) fabs(arg) log10(arg) round2(quantity, tanh(arg)
reference)
atan2(arg1,arg2) floor(arg) max(arg list) sign(arg) PI, pi − constant
ceil(arg) floor2(quantity, min(arg list) sign2(quantity, E, e − constant
reference) reference)
ceil2(quantity, int(arg) nint(arg) sin(arg)
reference)

Rounding Functions

The following rounding functions are designed to perform with, and restricted for use with, dimen-
sionless quantity arguments for which the results are in the same unit system:

• ceil

• floor

• int

• nint

• round

• trunc

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
298 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Parameters

If these functions are used on quantities with units, an error message is displayed.

To perform rounding operations on quantities, use the following functions:

• ceil2

• floor2

• int2

• nint2

• round2

• trunc2

These functions support both numeric values and quantities. When used for quantities, the format is
func(quantity, reference). The quantity argument is converted to the unit of the reference
argument, then the resultant quantity value is rounded to the nearest reference value.

For example, to calculate a ceiling value rounded up to the nearest whole meter, enter
ceil2(quantity, 1[m]).

Sign Function

Like the rounding functions, the sign function is designed for dimensionless quantities and numbers.
To perform this operation on quantities, use the sign2 function.

The format is sign2(quantity, reference), but in this case the value of the reference argument
has no significance in the calculation, only the unit used for conversion matters.

For example, both sign2(3 [cm], 1 [in]) and sign2(3 [cm], 10 [in]) return 1, indic-
ating that the value of 3 cm converted into inches is a positive number.

Trigonometric Functions

The arguments for trigonometric functions are evaluated as follows:

• If the argument is a real number or integer, the argument is evaluated as radians.

• If the argument is a quantity (which has a value and units), the argument must be of type Angle.
The evaluation is based on the supplied units ([deg] or [rad]).

Quantities
Expressions that involve quantities must be dimensionally consistent. The + and − operators require
that the two operands have compatible units. For example, you cannot add an Area parameter to
a Length parameter. Both units must be Length or both units must be Area. The * and / operators
do not have this limitation. They allow one operand to be a quantity with a unit and the other operand
to be a dimensionless factor. Or, they allow both operands to be quantities with units where the
result is a different quantity type. For example, Length/Time results in a quantity with a Velocity
unit.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 299
Working with Parameters and Design Points

If the expression defining a custom parameter results in a quantity, Workbench infers its quantity
name from the value produced by the expression evaluation. Consequently, if the expression is a sum
of multiple terms, every term must be using the same quantity name. For example, if the resulting
quantity is 3.4[m^2], the new custom parameter must have its Quantity Name property set to
Area. In some cases, more than one quantity name may be valid for the expression. In these cases,
the Quantity Name property is not set, but you can select from a list for the Quantity Name property
in the Properties pane for the parameter. Once the quantity name is determined from the unit of
the value, it can be subsequently changed only by changing the Quantity Name property for the
parameter. For example, you cannot change the expression from Area to Volume without changing
the Quantity Name property.

Once the value quantity name (such as Area) is determined from the unit of the value, it can only
be subsequently changed by changing the Quantity Name property for the parameter. You cannot
change the expression (for example, from area to volume) without changing the Quantity Name
property. Automatic unit conversion is only done when the quantity name is known. If you want to
express a temperature difference, start with temperature in absolute units.

Units
You can include units, assuming that the unit makes sense in context of the expression. For example,
P2+3[mm]*P3 is valid if mm is a valid unit expression for P2 and P3. For example, mm is a valid unit
expression if P2 is torque and P3 is force, or if P2 is area and P3 is length.

The project unit system is used to evaluate the expressions. For temperatures, absolute temperature
values are used in expression evaluation. All quantity values in an expression are converted to the
project unit system.

The general units syntax in Workbench is defined as multiplier|unit|^power, where:

• multiplier is a multiplying quantity or its abbreviation, such as mega (M) or pico (p)

• unit is the unit string or abbreviation, such as gram (g), pound (lb), foot (ft), or meter (m)

• power is the power to which the unit is raised

The following tables are examples of multipliers and commonly used units

Table 7: Unit Multipliers

Multiplier Multiplier Multiplier

Name Value Abbreviation
exa 1018 E
peta 1015 P
12
tera 10 T
9
giga 10 G
6
mega 10 M
3
kilo 10 k
2
hecto 10 h
1
deca 10 da
-1
deci 10 d

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
300 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Parameters

Multiplier Multiplier Multiplier

Name Value Abbreviation
centi 10-2 c
-3
milli 10 m
-6
micro 10 u
-9
nano 10 n
-12
pico 10 p
-15
femto 10 f
-18
atto 10 a

Table 8: Example Quantities and Units

Quantity Dimensionality Example Units

Acceleration Length Time^-2 m s^-2
ft s^-2
in s^-2
um ms^-2
Current Current A
mA
pA
Density Mass Length^-3 kg m^-3
g cm^-3
lb ft^-3
slug in^-3
slinch in^-3
Electric Charge Current Time As
coulomb
pA s
Energy Mass Length^2 Time^-2 J
BTU
erg
lbf ft
slug in^2 s^-2
Force Mass Length Time^-2 dyne
N
pdl
lbf
slug in s^-2

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 301
Working with Parameters and Design Points

Quantity Dimensionality Example Units

Length Length m
cm
foot
in
mm
micron
ft
um
yard
Pressure Mass Length^-1 Time^-2 Pa
MPa
N m^-2
bar
torr
mm Hg
psi
psf
atm
dyne cm^-2
Power Mass Length^2 Time^-3 W
BTU s^-1
HP
erg s^-1
lbf ft s^-1
Temperature Temperature K
C
R
F
Temperature Temperature K
Difference
C
R
F
Temperature Temperature^2 K^2
Variance
C^2
R^2
F^2

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
302 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Parameters

When typing units in an expression, you must enclose the units in square braces [...]. You generally
do not see the braces when selecting units from a list of commonly used units. In general, units de-
clarations must obey the following rules:

• A units string consists of one or more units quantities, each with an optional multiplier and optional
power. Each separate units quantity is separated by one or more spaces.

• Abbreviations for multipliers and unit names are typically used, but full names are also supported.

• Powers are denoted by the ^ (caret) symbol. A power of 1 is assumed if no power is given. A neg-
ative power is typically used for unit division. For example, [kg m^-3] corresponds to kilograms
per cubic meter.

• If you enter units that are inconsistent with the physical quantity being described, then an expression
error occurs.

• Units do not have to be given in terms of the fundamental units, which are mass, length, time,
temperature, angle, and solid angle. For instance, Pa (Pascals) and J (Joules) are both acceptable
as parts of unit strings.

• Units strings are case sensitive. For example, Kg and KG are invalid units strings; kg is correct.

Caution:

When the specified project unit system uses the relative temperature units (C or F), the
evaluation of expressions involving temperature, temperature differences, or temperature
variances is a special case.

For the unit conversion of a specific temperature value, 1 degC = 274.15 K. However,
the unit conversion for a temperature interval (delta T) is 1 degC = 1 K. The expression
evaluator takes any temperature value and treats it as a specific temperature (not a tem-
perature interval) by converting it to the absolute unit of the project unit system (either
K or R). If the intent is to perform the evaluation in terms of temperature intervals, you
need to start with temperatures in absolute units.

Similarly, any expressions to be evaluated in terms of temperatures or temperature differ-

ences are converted to absolute units for calculation. In an expression with a temperature
unit raised to a power other than 1 or a unit involving both temperatures and other units
(for example a temperature gradient [C/m]), the temperature is assumed to be a temperature
difference.

Table 9: Scenarios in which temperature-related units are converted before and during expression
evaluation

Scenario Example
Temperature unit conversion 10[C] * 2 = 566.3[K] = 293.15[C]
Temperatures appearing as part of a mixed unit are 10[C/m] * 50 [m] = 500[K]
converted as temperature intervals
Temperatures raised to a power other than 1 are 10[C^3] * 10[C] = 2831.5[K^4]
converted as temperature intervals

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 303
Working with Parameters and Design Points

Sound Pressure Level and A Weighted Sound Pressure Level are dimensionless quantities with units
dB and dBA, respectively.

• Math operations between these two units or either of these and a numerical value will result
in a value with no unit. For example, 10 db x 10 = 100. (no unit)

• Math operations between either of these units and a dimensional unit will result in a value
with the dimensional unit. For example, 10 db x 10 m = 100 m.

Table Parameters and Design Points

Table parameterization uses the Mechanical Table object, which allows you to create multivariable
tables of data. These tables can be used to specify loads on boundary conditions for analyses in
Mechanical. Parameterization lets you perform design point studies with different tables of pressure
and/or temperature load data. This feature is only supported for analyses with the Mechanical APDL
solver.

Define a table parameter by checking the box next to Table Assignment when you assign a table
to a boundary condition in Mechanical. Workbench recognizes the parameterized value and adds a
Parameter Set to the project as described in Creating or Editing Parameters (p. 304).

The table assignment from Mechanical is listed on the Outline of All Parameters pane. The drop-
down menu under Value lists all of the tables with dependent variables that are compatible with the
load on the boundary condition where the table is assigned. For example, if you assigned a table in
Mechanical to specify the magnitude of a pressure load, the drop-down menu lists all tables that
have pressure or pressure components as dependent variables.

Each parameterized table represents a design alternative. Workbench automatically creates an initial
design point (DP0) for the parameterized table. To investigate different boundary condition loads,
add more design points and assign different tables to them. See Working with Design Points (p. 309).

Creating or Editing Parameters

The process of working with parameters begins when you define a parameter in an application, such
as your CAD system, Mechanical, or Fluent. For information on defining parameters, refer to the
documentation for each application in which you are working.

Workbench recognizes parameters defined in the individual applications and exposes them in the
Parameter Set bar, which can be shared by multiple systems. The Parameter Set bar is the visual
representation of the project's full parameter set. Double-clicking it opens the Parameter Set tab,
which displays all parameters defined for all systems in your project. Each parameter is identified by
its system of origin.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
304 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Parameters

Additionally, each system with parameters has a Parameters cell, which you can double-click to open
the corresponding Parameters tab. The Parameters tab for a given system displays all of the para-
meters defined for this system.

Each of these tabs has an Outline pane and a Properties pane for viewing and working with your
parameters.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 305
Working with Parameters and Design Points

The Outline pane lists the parameters, grouping them into Input Parameters and Output Parameters.
Input parameters affect the definition of the data model. Output parameters are analysis results that
are quantities of interest for the design.

Note:

On a Parameters tab, the title in the header for the Outline pane displays the ID of the
corresponding Parameters cell to indicate the source of the parameters. On the Parameter
Set tab, the title is Outline of All Parameters.

For each parameter, the Outline pane shows an ID, name, current value, and unit system. You can
edit most of these properties. The exceptions are the parameter IDs and the units for parameters with
quantity values. When you select a parameter, its properties are shown in the Properties pane.

The Properties pane displays information for the object selected in the Outline pane. The objects
available for selection include parameters, expressions, and charts.

To create or edit parameters:

1. To view the parameters, double-click the Parameters cell of a system or the Parameter Set bar.

2. To add a new custom input parameter:

a. In the Outline pane, to the right of New input parameter, click the New name cell and
type a name for the parameter.

b. Click the New expression cell and type either a constant value or expression for the para-
meter.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
306 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Parameters

3. To add a new custom output parameter, in the Outline pane, to the right of New output para-
meter, click the New expression cell and type either a constant value or expression for the
parameter.

Note:

When you define a derived parameter in the Parameter Set bar, Workbench keeps
the unit specified at the moment of its creation as the native unit. You can select
Units → Display Values as Defined to see the native unit. For example, if meter is
the unit specified when a derived parameter is created, meter is the native unit. If
you want the derived parameter to use inch as the native unit, you must specify inch
before you create the derived parameter.

4. If you parameterized the Assignment property of the Body or Part objects, the Material Name
property of a Material Assignment object, or a Table Assignment for a boundary condition in
the Mechanical application, select the desired parameter value from the drop-down list in the
Value cell next to the parameter name.

5. To edit the name of a parameter, in the Outline pane, click the Parameter Name cell and type
the new name.

6. To delete custom parameters:

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 307
Working with Parameters and Design Points

a. In the Outline pane, click the ID cell for a parameter to select it, or press Ctrl and click the
ID cell of multiple parameters to delete.

b. Right-click the selection and select Delete Selected Unlinked Parameters from the context
menu.

7. To show the properties for a parameter, click the ID cell for that parameter.

8. To add or edit an expression, in the Properties pane, click the Expression Value cell and type
the new expression.

9. For an expression, once the quantity name (such as area) is determined from the unit of the
value, it can only be changed by changing the Quantity Name property for the parameter. In
the Properties pane, from the Quantity Name drop-down list, select a new value.

10. To add or edit the parameter description, in the Properties pane, click the Description Value
cell and type the new description.

11. Once you have finished adding and editing parameters, update the project, system, or Parameters
cell (p. 248) to register the changes and return the values of the output parameters. Note that an
update operation can be lengthy, depending on the analysis details.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
308 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Design Points

Chaining an Output Parameter to an Input Parameter

You can chain an output parameter to an input parameter to allow an input to be driven directly
from the current value of an output, provided that the chaining does not create a circular dependency.

To chain an output parameter to an input parameter:

1. To view the parameters, double-click the Parameters cell of a system or the Parameter Set bar.

2. In the Outline pane, to the right of New input parameter, click the New name cell and type a
name for the parameter.

3. Click the New expression cell and type either a constant value or expression for the parameter.

4. Update the project, system, or Parameters cell (p. 248) to register the changes and return the
values of the output parameter. Note that an update operation can be lengthy, depending on
the analysis details.

Working with Design Points

Each design point is a single set of parameter values representing one design alternative. Basically, you
can think of a design point as a snapshot of your design given a set of input parameter values, where
output parameter values are calculated by an update of the project. Design points allow you to perform
what-if studies and can be created in the Parameter Set bar or generated with ANSYS DesignXplorer.

You manage design points in the Table pane for the Parameter Set tab or on a Parameter tab. The
Table pane displays the design points.

From the Table pane, you can see existing design points and perform the following operations:

• Add new design points

• Duplicate existing design points

• Enter or change the input parameter values for design points

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 309
Working with Parameters and Design Points

• Delete existing design points except for the current one

• Specify the design point update order

• Update design points, either locally or through Ansys Remote Solve Manager

• Retain design point data within the project for design points other than the current, which by default
has retained data

• Preview the image from the project report (p. 271), assuming that the project has design points, is
solved, and a saved project report exists

• Set a design point with retained data as the current design point

• Export selected design points to separate projects

• Export a CSV file of the design points table

The design point that you interact with on the Project Schematic is always the current design point.
Initially, the current design point is DP 0. However, you can set any design point that has retained results
to be the current design point. You cannot rename or delete the current design point.

If you add a new design point, change its input parameter values, and update the project, you calculate
output parameter values for this new design point. You can then perform what-if studies to compare
this design to other designs.

Related topics:
Multiple Design Points Workflow
Adding a New Design Point by Duplicating an Existing Design Point
Adding a New Design Point by Entering Values
Updating Design Points
Retaining Design Point Data
Reviewing the Retained Data Column
Retaining Parameter Data for Solved Design Points with DesignXplorer
Setting a Different Design Point as Current
Copying Input Parameter Values to the Current Design Point
Exporting Design Points to New Projects
Exporting Design Point Parameter Values to a Comma-Separated Values File
Performing and Retaining Partial (Geometry-Only) Updates
Design Point States

Multiple Design Points Workflow

Workbench allows you to create multiple design points and generate comparison studies (what-if
studies) of input and output parameters.

To analyze your simulation across several design points:

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
310 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Design Points

1. In Ansys applications, generate input parameters for the current project (and, if appropriate,
specify output parameters to be created).

A Parameters cell is added to the relevant systems and a Parameter Set bar is added to the
project. The current project is designated as design point 0, or DP 0.

2. Create or edit the input parameters (p. 304).

3. Create multiple design points by duplicating an existing design point or by entering values.

4. Set whether you want to retain the files generated during the design point update for further
analysis.

Workbench saves the data for the current design point, any retained design points, and the values
of the output parameters computed for each design point.

5. Update the design points.

Adding a New Design Point by Duplicating an Existing Design Point

When you duplicate a design point, all parameters, parameter values, design point states, and design
point export settings are copied. You can then modify any of these values as required.

To duplicate an existing design point:

1. To open the Table pane, double-click the Parameters cell of a system or the Parameter Set
Bar.

2. Right-click a design point in the Table pane and select Duplicate from the context menu.

The following Show-Me animation is presented as an animated GIF in the online help. If you are reading
the PDF version of the help and want to see the animated GIF, access this section in the online help. The
interface shown may differ slightly from that in your installed product.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 311
Working with Parameters and Design Points

Adding a New Design Point by Entering Values

You can add a new design point by entering parametric values in the Table pane.

To enter values:

1. To open the Table pane, double-click the Parameters cell of a system or the Parameter Set
bar.

2. In the bottom row of the table, below the existing design points, type a parametric value in one
or more of the cells.

The following Show-Me animation is presented as an animated GIF in the online help. If you are reading
the PDF version of the help and want to see the animated GIF, access this section in the online help. The
interface shown may differ slightly from that in your installed product.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
312 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Design Points

Updating Design Points

Output parameter values for a design point are calculated when you update the design point. You
can update only the current design point, a set of selected design points, or all design points. Updating
design points updates solution data only where output parameters have been defined.

You have several options for updating design points. The settings specified by the Design Point
Initialization property apply. For more information, see Specifying the Initialization Conditions for a
Design Point Update (p. 318).

When you update multiple design points, you can choose the order in which design points update.
You can also choose the initial conditions with which they update.

You may want to specify the order for design point updates to improve efficiency. For instance, if
several design points use the same geometry parameter values, it is more efficient to process them
together so as to update the geometry only once.

By default, when each design point is updated, the design point is initialized with the data of the
design point designated as current. Retained design points with valid retained data are exceptions
because they do not require initialization data. In some cases, it may be more efficient to update each
design point starting from the data of the previously updated design point, rather than restarting
from current design point each time.

To update design points in Remote Solve Manager (RSM), see Updating Design Points in Remote
Solve Manager (p. 360).

Non-parametric changes made to a project with up-to-date design points may cause all existing
design points to go out-of-date, if the change is related to the parametric study being performed.
Any change not relevant to the parametric study, such as adding a standalone system or making a

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 313
Working with Parameters and Design Points

change downstream of the study, should not cause design points to go out-of-date. For changes that
invalidate the design points table, you must update the project, which can require significant time
and computing resources. You should always save your project after updating all design points and
before further modifying the project.

In most cases, a design point update applies only to cells affected by parameter changes and to cells
downstream. Cells without associated parameters or cells whose associated parameters did not change
are not updated.

Related topics:
Setting the Design Point Update Option
Updating Only the Current Design Point
Updating Selected Design Points
Update All Design Points
Fixing an Interrupted Design Point Update
Changing the Design Point Update Order
Specifying the Initialization Conditions for a Design Point Update
Setting Systems using CFD-Post to Update with Design Points

Setting the Design Point Update Option

Before updating design points, you must set the location where the updates are processed.

To set the design point update option:

1. On the Project Schematic, right-click the Parameter Set bar and select Properties from the
context menu.

2. In the Properties pane, from the Update Option drop-down list, select from the following
options:

• Run in Foreground: Runs the design point update within the current Workbench session.
This option is appropriate for quick-running updates that fit within the resources of your
workstation. This option is also the most robust as it is not possible to make changes that
impact the design points. When a design point update is executing in the foreground, you
cannot change or save the project, but you can interrupt or stop the update.

• Remote Solve Manager: Runs the design point update in the background by submitting it
to RSM using HPC shared licensing features.

Use this option for long-running updates that do not fit within your workstation's resources.
When you submit an update, RSM can send it to a remote compute cluster or to a Cloud
portal. RSM can also submit jobs to the local machine to allow the queuing of updates on
your workstation.

For more information on submitting design point updates to RSM, see Updating Design
Points in Remote Solve Manager (p. 360).

• Submit to Design Point Service (DPS): Runs the design point update in the background
by submitting it to DPS. Use this option to quickly and efficiently evaluate large numbers

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
314 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Design Points

of design points simultaneously using multiple compute resources, including ad-hock net-
works, Amazon web services, and Remote Solve Manager.

For more information on submitting design point updates to DPS, see Working with Design
Point Service (p. 371).

Updating Only the Current Design Point

To update just the current design point, update the project (p. 249).

Updating Selected Design Points

You can choose a set of design points from the table to update.

To update selected design points:

1. To open the Table pane, double-click the Parameters cell of a system or the Parameter Set
bar.

2. Press Ctrl and click each design point in the table to update.

3. Right-click the selection and select Update Selected Design Points from the context menu.

If the update for one of the design points fails, the Update Failed, Update Required ( ) icon is
displayed for the failed design point, but the next design point update begins immediately. The
Messages pane opens, showing the error message for the one or more design points that failed.
When the update process is complete, a failure summary dialog box opens. Review the error mes-
sages for details on which design points failed to update.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 315
Working with Parameters and Design Points

Update All Design Points

You can update all design points in the table.

To update all design points:

1. To open the Table pane, double-click the Parameters cell of a system or the Parameter Set
bar.

2. To update the design points:

• From the menu bar select Tools → Update All Design Points.

• On the Project tab toolbar click Update All Design Points.

• Right-click the white space on the Project Schematic and select Update All Design Points
from the context menu.

If the update for one of the design points fails, the Update Failed, Update Required ( ) icon is
displayed for the failed design point, but the next design point update begins immediately. The
Messages pane opens, showing the error message for the one or more design points that failed.
When the update process is complete, a failure summary dialog box opens. Review the error mes-
sages for details on which design points failed to update.

Fixing an Interrupted Design Point Update

If the update of a design point is interrupted, the partially updated icon ( ) is displayed beside
the values of the output parameters for the interrupted component. The next time that this design
point is selected for update, a dialog box opens.

To continue, select from the following options:

• Use Partially Updated: Accepts output parameters that are only partially updated as up-to-date,
using the existing results to update design points.

• Update All: Restarts the interrupted update, recalculating results for all output parameters that
are partially updated and then updating all design points. The dialog box notes that this can be
a lengthy process.

Changing the Design Point Update Order

By default, design points are updated in the order in which they appear in the design points table.
The Update Order column shows the order number for each design point. To view the column,
right-click in the table and select Show Update Order from the context menu.

To change the order that design points are updated in, select from the following options:

• Right-click the table and select Optimize Update Order from the context menu.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
316 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Design Points

An optimal update order is determined by an analysis of parameter dependencies in the project

and a scan of parameter values across all design points. The Update Order value for each design
point is updated automatically.

Note:

The primary goal of Optimize Update Order is to reduce the number of geometry
and mesh system updates. In general, the optimized order is driven by the order of
the update tasks, which means that the components are updated depending on their
order in the system, their data dependencies, their parameter dependencies, and the
state of the parameters. This works best in a horizontal schematic with geometry as
the first separate system. In a single vertically-integrated system project, the parameters
defined in the upper components are considered the most important. In some cases,
because of the order of parameter creation or the presence of engineering data
parameters, you may find that the first columns are not geometry parameters. In this
case, Ansys recommends that you use the Optimize Update Order option to sort by
geometry parameters.

• Edit the values in the Update Order column.

• Sort the table by one or several columns and then right-click in the table and select Set Update
Order by Row.

The Update Order value for each design point is regenerated to match the sorting of the table.

The following Show-Me animation is presented as an animated GIF in the online help. If you are reading
the PDF version of the help and want to see the animated GIF, access this section in the online help.
The interface shown may differ slightly from that in your installed product.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 317
Working with Parameters and Design Points

Specifying the Initialization Conditions for a Design Point Update

When a design point is updated, the solver is initialized with data. Design points with valid retained
data use that as their initialization data. Other design points either:

• Initialize with the data of the design point designated as current (From Current)

• Initialize starting from the data of the previously updated design point (From Previous Updated).

Using the From Previous Updated initialization value works best when:

• Sequential design points share the same geometry. For example, if DP 2 has the same geometry
as DP 1, but both of these differ from DP 0, changing the default behavior saves the computa-
tional cost of updating both the geometry and the mesh for DP 2.

• You have modified the design point update order in the Update Order column, either by editing
the values manually or by generating them with the Set Update Order by Row option.

• The design point update order has been optimized, either by the Optimize Update Order option
or by a DesignXplorer optimization.

To set how design points are initialized:

1. On the Project Schematic, right-click the Parameter Set bar and select Properties from the
context menu.

2. From the Design Point Initialization drop-down list, select the required initialization value.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
318 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Design Points

Setting Systems using CFD-Post to Update with Design Points

For systems using CFD-Post results, you can specify that the results cell is always updated with a
design point update operation, even when the update does not affect parameter values.

To set systems using CFD-Post to update with design points:

1. On the Project Schematic, right-click a CFD-Post Results cell and select Properties from the
context menu.

2. In the Properties pane, select the Always Include in Design Points Update check box.

Retaining Design Point Data

By default, Workbench does not retain design points after they are solved. It saves the calculated
data only for the current design point. For other design points, only the parameter values are saved.

In some cases, you might want to switch back and forth between multiple designs within the same
project. To do this, select one or more design points and retain their calculated data within the project.

To retain design points data:

1. To open the Table pane, double-click the Parameters cell of a system or the Parameter Set
bar.

2. For each design point you want to retain data for, select the Retained check box.

Note:

When this check box is selected, data for all systems inside the Workbench project
are stored for the design point, regardless of whether a system has connection to the
parameters. When only a small portion of the system is parameterized, retaining the
data is not efficient. This is a known limitation.

3. To generate retained design point data, update the design points (p. 313).

Once design point data has been retained:

• You can verify that the data has been retained and see the availability and state of the retained
data. For more information, see Reviewing the Retained Data Column (p. 319).

• You can view multiple designs by setting different design points as current. For more information,
see Setting a Different Design Point as Current (p. 321).

Reviewing the Retained Data Column

You can verify that data has been retained by viewing the icon in the Retained Data column for
each design point. This icon indicates the availability, validity, and state of the retained data for the
design point.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 319
Working with Parameters and Design Points

Different kinds of changes to the project have different impacts on retained data. Changes to the
parameter values for the design point cause the retained data to become out-of-date but still valid.
Non-parametric changes cause the retained data for non-active design points to become invalid.

Note:

During a local design point update, only the design point being updated is active. When
no update is in progress, only the current design point is active.

The state of the design point and the validity of its retained data do not necessarily match. It is possible
for a design point to be up-to-date while its retained data is invalid or vice versa.

When used in the Retained Data column, icons have slightly different meanings than they do else-
where in Workbench. The following table describes the meaning of each icon within the context of
retained design point data.

Icon State/Validity Description

Valid and up-to-date The design point has valid retained data that is up-to-date.
The retained data is available to be exported.
Valid but out-of-date The design point has valid retained data, but the retained
data is out-of-date because of a change to the design
point's parameter values. The retained data is available to
be exported.
Invalid or The design point either does not have retained data or
non-existing previously retained data has been invalidated by a
non-parametric change. The retained data is not available
to be exported.

Each state is illustrated in the image below, as follows:

• DP 0 (Current) has retained data that is valid and up-to-date. The current design point always
has valid retained data and the Retain check box is disabled.

• DP 1 has valid retained data that is current and up-to-date.

• DP 2 either does not have retained data or has retained data that is invalid.

• DP 3 has retained data that is valid but out-of-date.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
320 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Design Points

Retaining Parameter Data for Solved Design Points with DesignXplorer

When design points are updated, DesignXplorer provides the following methods of retaining para-
meter data for solved design points:

• It saves design point data to the design point cache. DesignXplorer reuses data from the cache
when you preview or update a Design Exploration system. For more information, see Cache
of Design Point Results in the DesignXplorer User's Guide.

• It exports design point data into design point log files. You can import the log file back into
DesignXplorer as needed. For more information, see Design Point Log Files in the .

• It allows you to export all design point values to an ASCII file. This functionality is available for
DesignXplorer charts or tables containing design point data, including the design points table.
You can then use the parameter values in the file with other programs for further processing
or import into DesignXplorer.

Note:

Both the design point log files and the ASCII file are formatted in the extended CSV
file format. For details, see Exporting Design Point Parameter Values to a Comma-
Separated Values File (p. 323).

Setting a Different Design Point as Current

Once multiple design points have retained data, you can switch back and forth between these multiple
designs within the project. To view the design associated with a given design point, you set it as the
current design point. Only design points with retained data can be set to current, and only one design
point can be set to current at a time.

To set a design point as the current design point:

1. To open the Table pane, double-click the Parameters cell of a system or the Parameter Set
bar.

2. In the Table pane, right-click a design point that has retained data (p. 319) and select Set as
Current from the context menu.

The design point becomes the current design point for the project. In the Name column, (Current)
displays after the name of the current design point. Setting a design point as current does not auto-
matically update it.

Note:

In a project that includes a Microsoft Office Excel system and uses retained design points,
switching to a different up-to-date design point automatically updates the Excel system.
This can be time-consuming if the spreadsheet contains macros or extensive calculations.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 321
Working with Parameters and Design Points

Copying Input Parameter Values to the Current Design Point

An alternate method to switching design points is to copy a different design point's input values to
the current design point. Copying the input values does not automatically update the design points.

To copy input parameter values to the current design point:

1. To open the Table pane, double-click the Parameters cell of a system or the Parameter Set
bar.

2. In the Table pane, right-click a design point and select Copy inputs to Current from the context
menu.

Exporting Design Points to New Projects

To work with the calculated data for a design point other than the current design point, you can export
the design point to a separate project. A new project is created for each design point that is exported.

When you export a design point, if the design point has already been exported, the existing exported
files are overwritten.

Note:

DesignXplorer data is not a part of design points and is not exported. DesignXplorer is a
consumer of design points but does not define design points. Consequently, it is not in-
volved when a design point is updated, or by extension, exported.

To export design points:

1. To open the Table pane, double-click the Parameters cell of a system or the Parameter Set
bar.

2. In the Table pane, select the design points.

3. Right-click the selection and select Export Selected Design Points from the context menu.

The data of each design point is saved to a new project, named filename_dpn (where dpn indicates
the number of the exported design point), with a project file named filename_dpn.wbpj. Working
files are saved to a filename_dpn_files directory that is a sibling to the original file-
name_files project folder.

The content of the new project depends on the state of the design point's retained data at the time
of the export:

• If valid retained data is available for an exported design point, the retained data is used to
create the new project. This retained data can be either up-to-date or out-of-date.

• If no valid retained data is available for an exported design point, the project exported is an
out-of-date project based on the current design point with the parameter values for this design
point applied. No valid retained data exists if the design point is either not selected to retain
data or is selected but retained data is not yet generated or has become invalid. You are asked

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
322 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Design Points

to confirm before the export of such a design point is performed. When you open the exported
project, it is out-of-date and requires an update to solve for the exported design point.

After an export, you must save the parent project before you can export design points again.

If a design point fails to export, the files for this design point remain in the project_files\dpn
directory until you delete them manually or attempt to update the design point again.

Exporting Design Point Parameter Values to a Comma-Separated Values

File
From the design points table, you can export the design point parameter values to a Comma-Separated
Values (CSV) file, which you can then use with other software tools for further processing. This file is
created in an extended file format. In addition to supporting standard CSV formatting, it supports
several Workbench-specific formatting conventions. The values are always exported in units as defined
in Workbench.

The file format includes the following components:

• Values are separated by commas.

• The optional header line indicates the name of each column.

• Each line is an independent record made of fields separated by commas.

• The format is not dependent on the locale, which means that the real number 12 and 345 one-
thousandths is always written as 12.345, regardless of the regional settings of the computer.

• If a line starts with the character #, it is considered a comment line rather than a header or data
line and is ignored.

• The header line is mandatory. It is the line where each parameter is identified by its ID (P1, P2, ...,
Pn) to describe each column. The IDs of the parameters in header line match the IDs of the para-
meters in the project.

• The first column is used to indicate a name for each row.

• A file can contain several blocks of data, with the beginning of each block being determined by a
new header line.

To export design point parameter values to a CSV file:

1. To open the Table pane, double-click the Parameters cell of a system or the Parameter Set
bar.

2. In the Table pane, right-click a cell and select Export Table Data as CSV from the context menu.

A file similar to the following is generated:

#
# 10/1/2012 10:38:01 AM
# The parameters defined in the project are:
# P1 - WB_B [mm], P2 - WB_D [mm], P3 - WB_L [mm], P4 - WB_P [N], P5 - WB_E [MPa],
# P10 - WB_SIG [MPa], P8 - WB_DIS [mm], P9 - WB_BUCK [N]
#

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 323
Working with Parameters and Design Points

# The following header line defines the name of the columns by reference to the parameters.
Name, P1, P2, P3, P4, P5, P10, P8, P9
DP 0, 2, 5, 100, 1000, 200000, 12000, 80, 1028.91145833333
DP 1, 3, 5, 150, 1000, 200000, , ,
DP 2, 5, 5, 20, 1000, 200000, , ,

Performing and Retaining Partial (Geometry-Only) Updates

To check your geometry for parametric failures, you can perform a geometry-only design point update.
When the partial results have been calculated, you can save them to the project to be used in sub-
sequent design point updates. You might do this if you want to generate the geometry updates on
one machine and then move the project to a machine that cannot update geometry.

To perform a geometry-only update:

1. On the Project Schematic, right-click the Parameter Set bar and select Properties from the
context menu.

If the Properties pane is already visible, click the Parameter Set bar to refresh the Properties
pane with the design point settings.

2. In the Properties pane, from the Update Option drop-down list, select Run in Foreground.

3. From the Partial Update drop-down list, select Geometry.

4. To retain the results from the partial update, from the Retain Partial Update drop-down list,
select Geometry.

Note:

This setting causes the geometry results to be saved whether you perform a partial
update or a full update.

Partial update data can exist from either a partial or full design point update. To remove existing
partial update data, set Retain Partial Update to None. The partial retained data is deleted from the
project the next time that design points are updated.

Design Point States

On the Parameters Set tab and any Parameters tab, the Outline and Table panes display icons on
output parameters to indicate their states.

• An output parameter that is up-to-date displays no icon. Only the value of the output parameter
is shown.

• An output parameter that is out-of-date displays the Update Required icon ( ). Either the output
parameter has not been solved or requires an update because local data has changed.

• An output parameter that has failed to update displays the Update Failed, Update Required icon
( ).

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
324 of ANSYS, Inc. and its subsidiaries and affiliates.
 Working with Design Points

• An output parameter that has partially updated values because of an interruption to either a project
update or a design point update displays the Partially Updated icon ( ).

During cell, system, project, and both local and remote design point updates, the Outline and Table
panes update the states of the output parameters.

Changes elsewhere in the project could cause the state of some, but not all, output parameters to
go out-of-date and require update. In those cases, only those output parameters affected by the
changes are shown as requiring an update. Output parameters that are not affected by the changes
remain up-to-date.

Changes to derived parameters or associated expressions are recalculated immediately rather than
requiring an update. If you add or change derived parameters, other parameters are not affected by
this change and so do not require an update.

Design points that are being updated using RSM display the Pending icon ( ) in the design points
table while the remote design point update is in progress. When each updated design point is retrieved,
associated output parameters reflect the results of the update.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 325
 Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
326 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with Ansys Remote Solve Manager
Ansys Remote Solve Manager (RSM) provides the central framework for job submission to an established
cluster or third-party Cloud. This enables you to access powerful compute resources when needed.

To enable job submission to a cluster or Cloud portal, an administrator must create configurations in
RSM. An RSM configuration contains information about the HPC resource where jobs are submitted
(such as the name of the cluster submit host, or URL of the web portal), file transfer methods, and the
queues that are available for job submission. (See RSM Configuration in the Remote Solve Manager User's
Guide.)

RSM configurations enable RSM to integrate with the following types of HPC resources:

• Commercial clusters. Includes Microsoft HPC, LSF, PBS Pro, UGE (SGE), TORQUE with Moab, and
custom clusters.

• Ansys Cluster (ARC). An ARC operates in the same way that a commercial cluster does, running Ansys
applications in local or distributed mode, but uses its own scheduling capability rather than that of
a third-party job scheduler.

Every RSM installation includes a default localhost ARC configuration that enables you to run
solutions and updates on your local machine, essentially making your machine a single-node cluster.

• Third-party Cloud. Through RSM customization, provides access to Cloud-hosted compute services.

Note:

• For a Microsoft HPC cluster, PSSH is not supported on Microsoft Windows for job submission.

• PBS, LSF, UGE and TORQUE clusters on Windows are not supported.

Once the configurations have been created, the administrator must share them with users. You must
then either copy the configurations into your default RSM configuration directory, or, if they reside in
a shared directory, change the path of your RSM configuration directory to the path of the shared dir-
ectory. (See Sharing and Accessing RSM Configurations in the Remote Solve Manager User's Guide.)

Once RSM configurations have been made available to your local machine, the RSM queues that are
defined in those configurations are listed in the RSM Queue drop-down menu when you select the
Submit to Remote Solve Manager option for updates and solutions. Each RSM queue is associated
with a specific HPC queue that has been created on the cluster/portal side. An HPC queue determines
the machine(s) where jobs are run.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 327
Working with Ansys Remote Solve Manager

Depending on the RSM queue chosen, jobs can be run locally in the background on your local machine,
sent to a remote machine, or distributed across multiple machines.

Note:

The naming scheme for jobs sent to RSM is as follows:

• For Mechanical jobs:

[client machine name]-[Workbench project name]-[design point name]-[Model node name

(including cell ID)]-[Environment node name (including cell ID)]-[Solution node name (in-
cluding cell ID)]

Example: MyWorkstation-MyProject-DP0-Model (A4)-Static Structural (B5)-Solution (B6)

• For CFX/Fluent/Polyflow/Mechanical APDL jobs:

[client machine name]-[Workbench project name]-[design point name]-[System name]-

[Component name (including cell ID)]

Example: MyWorkstation-MyProject-DP0-CFX-Solution (C3)

Jobs submitted to RSM can be monitored using the Workbench Job Monitor (see Monitoring and
Controlling Remote Solve Manager Jobs in Workbench (p. 356)).

This chapter assumes that RSM has been set up according to the instructions in the Remote Solve
Manager User’s Guide (see RSM Installation and Startup and RSM Configuration).

Related topics:
Specifying Credentials for Remote Solve Manager Job Submission
Submitting Solutions to Remote Solve Manager
Submitting Workbench Project Updates to Remote Solve Manager
Submitting System Coupling Jobs to Remote Solve Manager
Submitting Mechanical Application Jobs to Remote Solve Manager
Submitting Mechanical APDL Jobs to Remote Solve Manager
Submitting Fluids Jobs to Remote Solve Manager
Monitoring and Controlling Remote Solve Manager Jobs in Workbench
Updating Design Points in Remote Solve Manager

Specifying Credentials for Remote Solve Manager Job Submission

Remote Solve Manager (RSM) needs to acquire and cache your credentials to be able to submit jobs to
an HPC resource on your behalf. RSM's direct integration with Workbench and built-in caching capability
automates this process to a great extent.

When you submit a job to RSM from Workbench for the first time, and your credentials have not yet
been cached for the RSM queue in RSM, or the cached password does not validate because your OS
password has changed or expired, you are prompted to specify credentials for that queue:

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
328 of ANSYS, Inc. and its subsidiaries and affiliates.
 Submitting Solutions to Remote Solve Manager

If the credentials validate, the job is submitted to the HPC resource. If the credentials do not validate,
the job is aborted.

Submitting Solutions to Remote Solve Manager

You can use the Solution Process properties of a system's Solution cell to submit the solution to Remote
Solve Manager (RSM).

Use this option for long-running solutions that do not fit within your workstation's resources. When
you submit a solution, RSM can send it to a remote compute cluster, or to a Cloud portal. RSM can also
submit jobs to the local machine to allow the queuing of solutions on your workstation.

Note:

• When submitting solve jobs to the remote cluster, the license preferences set for your
local machine (the RSM client) may not be the same as the license preferences set for the
cluster. In this case, the cluster license preferences are used for all jobs.

• Solution cell updates via RSM are not supported for System Coupling; System Coupling
jobs must be sent to RSM either as project updates or design point updates. For more in-
formation, see Submitting System Coupling Jobs to Remote Solve Manager (p. 335).

To submit solutions to RSM:

1. Right-click the Solution cell of a system and select Properties from the context menu.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 329
Working with Ansys Remote Solve Manager

2. In the Properties pane, from the Update Option drop-down list, select Submit to Remote Solve
Manager.

Important:

When design points are configured to be updated in RSM, the Solution cell cannot also
be updated in RSM. In this case, change the Solution cell update settings by setting
the Update Option Solution Process property to Run in Foreground.

3. Set the following additional properties:

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
330 of ANSYS, Inc. and its subsidiaries and affiliates.
 Submitting Solutions to Remote Solve Manager

• Solve Process Setting (Mechanical application only): Select the solving configuration defined
in Mechanical.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 331
Working with Ansys Remote Solve Manager

• RSM Queue: Specifies a queue defined in RSM that maps to a specific HPC queue on the
cluster/portal side. Any RSM queues currently defined in RSM appear in this drop-down list. The
RSM Queue Details section displays the HPC Configuration, HPC Queue, and HPC Type (for
example, ARC, WinHPC, or LSF) that the RSM queue is associated with.

If a queue has been recently added in RSM and you do not see it in the list, select Refresh
Queues to update the queue list.

• Job Name: Displays the name reported in the RSM job log. The default name for a Workbench
job is Workbench, or whatever is set for the Default Job Name in your Workbench options.
The default name for a Mechanical job submitted from the Mechanical application is Mechan-
ical. The job name provides a traceable piece of data that administrators can use to track job
submissions to a cluster (for billing purposes, for example).

To override the default job name, double-click the Job Name Value cell and type the required
name.

Job name overrides must adhere to the following conventions:

– Can only use alphanumeric characters and ~ # % ^ , & * ' ( ) - _ + = / < >

– Cannot exceed 15 characters

– The first character must be one of the alphanumeric characters (a-z, A-Z, 0-9)

• Download Progress Information: Specifies that the solver monitor should periodically query
RSM for output files in order to display progress (where applicable). Queries begin when you
initiate an action to display the solution progress (such as choosing the Display Monitors option
in CFX). This option, available for Fluent and CFX systems, is enabled by default.

For CFX systems, select from the following options:

– Always Download Progress Information: Causes queries to RSM to begin immediately. This
option is enabled by default.

– Download Progress Information on Demand: Causes queries to RSM to begin when you
initiate an action to display the solution progress (such as choosing the Display Monitors
option in CFX).

For all other systems, select or clear the Download Progress Information check box.

• Progress Download Interval: Specifies the periodic time interval, in seconds, that the solver
queries RSM for output files to display progress. The default is 30. Setting this value to 0 results
in continuous queries; that is, as soon as files are downloaded from the execution node, Work-
bench immediately queries again. This option is available for Fluent and CFX systems.

• Execution Mode: Specifies the serial or parallel solver execution mode. The parallel option is
available only if the selected solver supports parallel execution mode. This option may not be
available with all systems.

When performing a design point update in RSM with component update in the foreground, the
Parameter Set properties override the parallel-process settings in individual components. For
details on updating design points, see Updating Design Points in Remote Solve Manager (p. 360).

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
332 of ANSYS, Inc. and its subsidiaries and affiliates.
 Submitting Workbench Project Updates to Remote Solve Manager

• Number of Processes: Specifies the number of processes to use for the solution if parallel exe-
cution mode is selected. The default is 2. Must be set to a number greater than or equal to 2.

4. To save the project, from the menu bar, select File → Save.

If you choose not to save the project and any cells are configured to use RSM or run in the back-
ground, you must change the solution process settings of those cells to run in the foreground
before you can update.

5. To start the solution, select the appropriate option from the application, or right-click the Solution
cell and select Update from the context menu.

The Solution cell enters the Pending state (p. 465).

Submitting Workbench Project Updates to Remote Solve Manager

You can submit a project to Remote Solve Manager (RSM) for remote update of the project. Depending
on how RSM is configured, the update can be submitted to an HPC cluster or Cloud portal for execution
(see Working with Ansys Remote Solve Manager (p. 327)).

Note:

If you are sending solve jobs to a remote cluster, the license preferences set for your local
machine (the RSM client) may not be the same as the license preferences set for the remote
cluster. In this case, the cluster license preferences are used for all jobs.

To submit a project update to RSM:

1. To open the project properties, from the menu bar select View → Properties or right-click the
white space of the Project Schematic and select Properties.

2. Under Solution Process, set the Update Option property to Submit to Remote Solve Manager.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 333
Working with Ansys Remote Solve Manager

3. Additional properties are displayed. Use these properties to specify your remote submission settings.

• RSM Queue: Select the queue to be used for the remote solution. Any queues currently defined
for RSM appear in the drop-down list. If you have added a queue and it does not appear in the
list, click Refresh Queues.

Every RSM queue is associated with a particular configuration that is defined in RSM. In the RSM
configuration, the RSM queue is mapped to a specific HPC queue that has been defined on the
cluster/portal side.

• Job Name: Displays the name reported in the RSM job log. The default name for a Workbench
job is Workbench, or whatever is set for the Default Job Name in your Workbench options.
The default name for a Mechanical job submitted from the Mechanical application is Mechan-
ical. The job name provides a traceable piece of data that administrators can use to track job
submissions to a cluster (for billing purposes, for example).

To override the default job name, double-click the Job Name Value cell and type the required
name.

Job name overrides must adhere to the following conventions:

– Can only use alphanumeric characters and ~ # % ^ , & * ' ( ) - _ + = / < >

– Cannot exceed 15 characters

– The first character must be one of the alphanumeric characters (a-z, A-Z, 0-9)

• Pre-RSM Foreground Update:

– To update your geometry locally before submitting project updates to RSM, select Geometry.

Select this option if the execution node does not have a license to perform geometry updates.

– To submit project updates to RSM without first updating the geometry locally, .select None.

• Component Execution Mode: Specifies the serial or parallel solver execution mode. The parallel
option is available only if the selected solver supports parallel execution mode. This option may
not be available with all systems.

When performing a design point update in RSM with component update in the foreground, the
Parameter Set properties override the parallel-process settings in individual components. For
details on updating design points, see Updating Design Points in Remote Solve Manager (p. 360).

• Remote Job Status Check Interval in Seconds

Sets the number of seconds between each query to Remote Solve Manager for the Mechanical
solution update job status. The default is 20. This setting only takes effect when the Mechanical
solution is submitted to RSM.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
334 of ANSYS, Inc. and its subsidiaries and affiliates.
 Submitting System Coupling Jobs to Remote Solve Manager

The Project Update properties specified here are shared with the Parameter Set as Design Point
Update Process properties. Changes to the values of these properties here are reflected in the Para-
meter Set properties, and vice versa.

Note:

In most cases, the Update Project button or menu item updates all systems and cells in a
project. When a project update is submitted to RSM as described, however, only those systems
above the Parameter Set bar are sent to RSM for remote update. If needed, DesignXplorer
systems can be further updated once the remote project update is completed.

Submitting System Coupling Jobs to Remote Solve Manager

Tip:

For remote execution of a co-simulation created in Workbench, the recommended workflow

is to export the coupling setup from Workbench and then run the co-simulation in System
Coupling's GUI or CLI, using System Coupling's parallel processing capabilities to submit jobs
for remote execution.

A System Coupling co-simulation may be sent to Remote Solve Manager (RSM) for remote execution
either as a full project update or a design point update.

Note:

• Solution cell updates via RSM are not supported for System Coupling; for a System
Coupling system's Solution cell, Run in Foreground is the only option available for the
Solution Process | Update Option property. As such:

– If you attempt to solve the coupled analysis by updating System Coupling's Solution
cell, then the update will not be sent to RSM, regardless of the Update Option
setting for the project or the Parameter Set.

– Because coupling participant solutions are tied to the update of System Coupling's
Solution cell, participant setups should be consistent with System Coupling's setup.
Ensure that all participant Solution cells are also set to solve in the foreground.

• When submitting a job on a machine that uses Microsoft HPC Pack 2019, you may receive
an error message indicating that the coupling process failed to start. To address this issue,
submit the job on another resource, either by using an earlier version of HPC Pack or by
submitting the job on a Linux system.

For more information on working with RSM, see:

Submitting a Coupled Analysis Project Update to RSM
Submitting a Coupled Analysis Design Point Update to RSM
Distribution of Computing Resources Across System Coupling Participants
Restricting Solve Processes for System Coupling Updates

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 335
Working with Ansys Remote Solve Manager

Monitoring System Coupling Solution Information

Restarting an Interrupted Remote Update

Submitting a Coupled Analysis Project Update to RSM

To send a coupled analysis project update to RSM, perform the following steps:

1. Set the project's Solution Process and Project Update properties as described in Submitting
Workbench Project Updates to Remote Solve Manager (p. 333).

2. Click the Update Project button in the Workbench toolbar.

All the systems on the Project Schematic, including the System Coupling system, are updated
through RSM.

Submitting a Coupled Analysis Design Point Update to RSM

To send a coupled analysis design point update to RSM, perform the following steps:

1. On the Project Schematic, right-click the Parameter Set bar and select Properties.

Corresponding settings are shown below in the Properties pane.

2. Use the steps outlined in Updating Design Points in Remote Solve Manager (p. 360) to set the
following properties:

a. Solution Process

b. Design Point Update Process

Note:

Because design point updates are performed only on output parameters, a

System Coupling system that does not affect outputs may not be updated
during a design point update. However, when updating retained design
points (including Current), you can ensure that all project systems are up-
dated. To do so, set the Retained Design Point property to Update full
project, then right-click the Current design point and select Update selected
design points.

3. Save the project.

If you are working in an archived project, save the project to a permanent location.

4. Update the design point(s), using any of the methods documented in Updating Design
Points (p. 313) (that is, updating the Current design point, selected design points, or all design
points).

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
336 of ANSYS, Inc. and its subsidiaries and affiliates.
 Submitting System Coupling Jobs to Remote Solve Manager

The project is archived and submitted to a cluster using RSM. The remote data is retrieved periodically
as the design point updates complete. Should a design point update fail, an error is reported to the
Messages pane.

Distribution of Computing Resources Across System Coupling Participants

In a project with System Coupling, the individual components (such as Fluent, Mechanical, or CFX)
share resources. By default, when design points from a project containing a System Coupling system
are submitted to RSM, available computing resources are distributed equally across all coupling par-
ticipants according to the number of compute nodes available and the number of processes requested.
Component-level parallel settings (such as the Execution Mode and Number of Processes properties)
are disregarded during the design point update.

Example 1: Six Processes

If a coupled simulation requests six processes to be executed on a cluster that has six nodes with
one processor per node, then participant solvers will start six processes, with one on each compute
node. The participant solvers alternate their processing, so that only one participant is actively using
computing resources at a time.

Solver Processes for Participant Solver Processes for Participant

Node
1 2
1 1 1
2 1 1
3 1 1
4 1 1
5 1 1
6 1 1

Example 2: Ten Processes

If a coupled simulation requests 10 processes to be executed on a cluster that has 4 nodes with 8
processors per node, then each participant solver will start 10 processes.

Solver Processes for Participant Solver Processes for Participant

Node
1 2
1 8 8
2 2 2
3 0 0
4 0 0

Restricting Solve Processes for System Coupling Updates

When submitting an update for parallel processing, you can limit the number of solve processes that
a coupling participant can use when updates are submitted to Remote Solve Manager (RSM). To do
so, set the Restriction for Project / Remote Design Point Update properties for the participant's
Solution cell, as described in Updating Design Points in Remote Solve Manager (p. 360).

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 337
Working with Ansys Remote Solve Manager

The solve process limitations are applied only to that component, and resources are otherwise allocated
equally across participants. Resource allocation for the restricted participant is as follows:

• If the component's Specify Number of Processes Restriction is enabled and the Number of
Processes Used Not to Exceed (or Max Number of Utilized Cores) value is less than or equal to
the number of processes requested by the project, then the component is limited to the component-
specified number of processes.

• If the component's Specify Number of Processes Restriction is enabled and the Number of
Processes Used Not to Exceed (or Max Number of Utilized Cores) value is set to a value greater
than the number of processes requested by the project, then the component is limited to the
project-specified number of processes.

• If the component's Serial Execution Only is enabled, then the component is limited to a single
process.

Monitoring System Coupling Solution Information

As the remote design point update progresses, a single System Coupling Transcript/Log file
(scLog.scl) is generated for the coupling project and displayed in the Solution Information pane
of the System Coupling workspace. It is updated intermittently so you can use it to monitor the design
point update.

Note:

When multiple design points are being updated simultaneously, you cannot switch between
the log files for the different design points. During and after completion of the updates,
System Coupling displays the log file for the design point with the highest ID. To display
the log file for the Current design point, you must save and reopen the project.

For more information, see the following sections in the System Coupling User's Guide:

• Monitoring Solution Progress

• Transcript and Log File

Restarting an Interrupted Remote Update

When a remote System Coupling update has been interrupted:

• For a project update, the Solution cells in your project are given a state of Interrupted, Up to
Date ( ):

• For a design point update, the output parameters for the interrupted component are given a
state of Partially Updated ( ).

To restart the update:

1. In the Workbench toolbar, click the Update Project or Update All Design Points button.

2. In the dialog box that opens, click one of the following buttons:

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
338 of ANSYS, Inc. and its subsidiaries and affiliates.
 Submitting Mechanical Application Jobs to Remote Solve Manager

• Use Partially Updated: Accepts the partially updated solution as Up-to-Date ( ) and
uses it to restart the update.

• Update All: Restarts the interrupted run, updating all solutions to completion before re-
starting the update.

Submitting Mechanical Application Jobs to Remote Solve Manager

Use the following steps to submit Mechanical jobs to a cluster or Cloud portal using Remote Solve
Manager (RSM).

1. Configure your remote solution settings in Remote Solve Manager.

See RSM Configuration in the Remote Solve Manager User's Guide.

2. To launch the Mechanical application, on the Project Schematic, double-click the Solution cell in
your Mechanical system.

3. In the Mechanical application, on the Home tab, select Solve Process Settings.

Alternatively, switch to the File tab and select Solve Process Settings.

4. Follow the instructions in Using Solve Process Settings to configure your solution settings.

The settings established here are visible in the Solution Process properties in Workbench.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 339
Working with Ansys Remote Solve Manager

5. In Workbench, select the Solution Process settings that you want to use for this solution and update
the Solution cell (p. 250).

Alternatively, in the Mechanical application, on the Home tab select Solve then select a configur-
ation from the drop-down list.

Note:

• You can interrupt or abort an update by right-clicking the Solution cell. These options
are available during foreground, background, Portal and RSM updates.

• The Workbench Options allow you to control the Mechanical application's license
handling. As described in Mechanical (p. 447), you can configure the license to always
be released during batch run or to be released when you perform an Update All
Design Points run. A third option is On Demand, which makes a Release License

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
340 of ANSYS, Inc. and its subsidiaries and affiliates.
 Submitting Mechanical Application Jobs to Remote Solve Manager

option available on the Solution cell's context menu when the cell is in the pending
state during a batch run.

Workbench/RSM Integration with the Mechanical Application

The properties associated with a Mechanical system's Solution cell include a Solution Process section.
This section allows you to specify the Solve Process Setting for the Mechanical application to use
when an update operation is initiated from Workbench. You can select only an existing solve process
setting, but new solve process settings can be added (and existing solve process settings can be
modified) by selecting Tools → Solve Process Settings in the Mechanical application.

Note:

Any solve initiated in the Mechanical application ignores the solution component properties
selected in Workbench and continues to work as it has in previous versions.

Example 3: Default Update with My Computer Set as the Default Solve Process Setting

In this case, the default Solve Process Setting in the Mechanical application is My Computer.

In Workbench, the Solution Process property Update Option is set to Use application default,
which causes Mechanical to use its default solve process setting.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 341
Working with Ansys Remote Solve Manager

Results:

Solve Initiated From Solve Process Setting Used

Workbench My Computer
Mechanical My Computer

Example 4: Default Update with My Computer, Background Set as the Default Solve Process
Setting

In this case, the default solve process setting in the Mechanical application is My Computer, Background.

In Workbench, the Solution Process property Update Option is set to Use application default,
which causes Mechanical to use its default solve process setting.

Results:

Solve Initiated From Solve Process Setting Used

Workbench My Computer, Background
Mechanical My Computer, Background

Example 5: RSM Update Using My Computer, Background, with My Computer Set as the Default
Solve Process Setting

In this case, the default solve process setting in the Mechanical application is My Computer.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
342 of ANSYS, Inc. and its subsidiaries and affiliates.
 Submitting Mechanical APDL Jobs to Remote Solve Manager

In Workbench, the Solution Process property Update Option is set to Submit to Remote Solve
Manager. The solve process setting selected in Workbench is My Computer, Background.

Results:

Solve Initiated From Solve Process Setting Used

Workbench My Computer, Background
Mechanical My Computer

Submitting Mechanical APDL Jobs to Remote Solve Manager

You can use Remote Solve Manager (RSM) as a serial or parallel solution for Mechanical APDL jobs. If
your RSM configuration directory contains configurations for a cluster or a Cloud portal, you can access
cluster/portal queues that act as a parallel solution option.

Note:

Mechanical APDL has the following limitations when used with Remote Solve Manager:

• Reconnect does not work after moving a project to another machine.

• Only one copy of a saved project that is in the pending state can reconnect successfully.

• You must manually save a project after a reconnect.

• Reference files must be in the same directory as the Ansys input file.

• Restarts of solves to a cluster are not supported from Workbench.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 343
Working with Ansys Remote Solve Manager

In the Solution Process pane:

1. Configure your remote solution settings in Remote Solve Manager. For more information see RSM
Configuration in the Remote Solve Manager User's Guide.

2. In Workbench, right-click the Solution cell and select Properties.

3. In the Solution Process settings, set the Update Option to Submit to Remote Solve Manager.

4. Select a RSM Queue.

5. Set the Execution Mode to either Serial or Parallel.

6. Set the number of Utilized cores. For a serial solution, select 1; for a parallel solution, specify the
number of partitions.

You should have at least 100,000 elements or nodes per partition to compensate for the overhead
associated with the partition. The cluster job scheduler automatically controls where the partitions
are solved.

7. Update the project (p. 249).

When the Mechanical APDL job is submitted to RSM, some options in the Properties pane (Pro-
cessors, Distributed, MPI Type, Machine List, and Custom Executable Path) become read-only
and their values are ignored.

Note:

If Download Distributed Files is checked, all files involved in a distributed solve are
downloaded.

Submitting Fluids Jobs to Remote Solve Manager

Use the following instructions to submit various fluid jobs to Remote Solve Manager (RSM).
Submitting CFX Jobs to Remote Solve Manager
Submitting Polyflow Jobs to Remote Solve Manager
Submitting Fluent Jobs to Remote Solve Manager
Submitting Icepak Jobs to Remote Solve Manager
Submitting Forte Jobs to Remote Solve Manager
Exiting a Project During a Remote Solve Manager Solution Cell Update

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
344 of ANSYS, Inc. and its subsidiaries and affiliates.
 Submitting Fluids Jobs to Remote Solve Manager

Submitting CFX Jobs to Remote Solve Manager

You can use Remote Solve Manager (RSM) as a serial or parallel solution for CFX jobs. If your RSM
configuration directory contains configurations for a cluster or a Cloud portal, you can access
cluster/portal queues that act as a parallel solution option.

Note:

CFX has the following limitations when used with Remote Solve Manager:

• RIF (Flamelet) cases are not supported.

• Reconnect does not work after moving a project to another machine.

• Only one copy of a saved project that is in the pending state can reconnect successfully.

• You must manually save a project after a reconnect.

• You cannot edit a run that is in progress.

• You cannot perform a remote backup.

• For runs that are submitted to a remote machine:

– Serial and local parallel runs are always supported.

– Other local parallel modes must be supported on the job host.

– Distributed parallel is supported only for multi-node clusters.

• The default update interval for display monitors is 120 seconds. Use the Download
Progress Information and Progress Download Interval options under Tools → Options
→ Solution Process to enable/disable polling or to change the polling interval. The
settings established here are also visible in the Solution Process properties pane in
Workbench.

In the Solution Process pane:

1. Configure your remote solution settings in Remote Solve Manager. For more information see
RSM Configuration in the Remote Solve Manager User's Guide.

2. In Workbench, right-click the Solution cell and select Properties.

3. In the Solution Process settings, set the Update Option to Submit to Remote Solve Manager.

4. Select a RSM Queue.

5. Set the Execution Mode to either Serial or Parallel.

For a parallel solution:

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 345
Working with Ansys Remote Solve Manager

• You can specify the Number of Processes that you want to use to create the results file. You
should specify a number that is less than or equal to the number of cores available in the
cluster, and you should ensure that each process contains at least 100,000 nodes or elements.

• UGE and PBS clusters must be configured to use the SSH communication protocol; RSH is not
supported. If you are using the Submit to Remote Solve Manager option, see Configuring
RSM to Use SSH for Job Submission and/or File Transfers to a Remote Linux Cluster in the Re-
mote Solve Manager User's Guide.

6. Update the project (p. 249).

You can interrupt or abort an update by right-clicking the Solution cell. These options are
available during foreground, background and RSM updates.

Note:

The monitoring of solution updates submitted to RSM has the following limitations:

• When you use the Solution cell's properties field to set the frequency at which you poll
the data, this represents a maximum frequency. In cases of network congestion or where
large files are involved, the observed monitor update frequency is less.

• Solution monitor data is transferred using the CFX Solver-Manager, which has a limited
capacity to handle monitor data transfer requests. In situations where multiple users are
using the same CFX Solver-Manager to monitor runs, or where multiple runs are being
monitored by a single user, the update frequency of monitor data may decrease or be-
come sporadic.

• When monitoring RSM updates, CFX Solver-Manager does not report run completion.
The Out File window displays the completed run information; however, CFX Solver-
Manager's workspace still displays Running. Note that in these cases, Workbench accur-
ately reports update completion.

Submitting CFX Jobs with Design Points to Remote Solve Manager

When performing a Design Point update with a CFX system using Remote Solve Manager (RSM),
the Component Execution Mode and Max. Number of Processes Per Job settings on the Para-
meter Set Properties pane control the parallel-processing settings that the CFX Solver uses. For
details, see Updating Design Points in Remote Solve Manager (p. 360).

Submitting Polyflow Jobs to Remote Solve Manager

Use the following steps to submit Polyflow jobs to Remote Solve Manager (RSM).

Note:

Polyflow has the following limitations when used with Remote Solve Manager:

• Reconnect does not work after moving a project to another machine.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
346 of ANSYS, Inc. and its subsidiaries and affiliates.
 Submitting Fluids Jobs to Remote Solve Manager

• Only one copy of a saved project that is in the pending state can reconnect successfully.

• You must manually save a project after a reconnect.

• The RSM interrupt option performs an abort operation, not an interrupt.

• Parallel design point submissions to batch queue clusters only run on the head node
and with the number of cores allocated by the batch queue scheduler.

In the Solution Process pane:

1. Configure your remote solution settings in Remote Solve Manager. For more information see
RSM Configuration in the Remote Solve Manager User's Guide.

2. In Workbench, right-click the Solution cell and select Properties.

3. In the Solution Process settings, set the Update Option to Submit to Remote Solve Manager.

4. Select a RSM Queue.

5. Update the project (p. 249).

You can interrupt or abort an update by right-clicking the Solution cell. These options are
available during foreground, background and RSM updates.

Submitting Fluent Jobs to Remote Solve Manager

You can use this feature to queue multiple jobs to run on the local machine (overnight, for example,
or during other low-usage times), or to submit a job to a remote cluster or Cloud portal.

Note:

Fluent has the following limitations when used with Remote Solve Manager:

• Only one copy of a saved project that is in the pending state can reconnect successfully.

• System Coupling is not supported.

• UDFs are supported but you must have a supported compiler on Windows 64-bit ma-
chines. Supported compilers for Windows are Microsoft Visual Studio 2008 Standard and
Microsoft Visual Studio 2010 Professional.

• On Linux, UDFs are supported. You can always send UDFs between Linux machines and
make use of the auto-compile feature; if the machines have compatible compilers, you
can send precompiled UDFs.

For additional information about compiling Fluent UDFs, see Compiling UDFs in the Fluent
Customization Manual.

In the Solution Process pane:

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 347
Working with Ansys Remote Solve Manager

1. Configure your remote solution settings in Remote Solve Manager. For more information see
RSM Configuration in the Remote Solve Manager User's Guide.

2. In Workbench, right-click the Solution cell and select Properties.

3. In the Solution Process settings, set the Update Option to Submit to Remote Solve Manager.

4. Select a RSM Queue.

5. Set the Execution Mode to either Serial or Parallel.

For a parallel solution, specify the Number of Processes that you want to use to create the
results file. You should specify a number that is less than or equal to the number of cores available
in the cluster, and you should ensure that each process contains at least 100,000 nodes or ele-
ments.

6. Update the project (p. 249).

An update of the Solution cell submits the job to RSM, moves into Pending mode for the duration
of the solution, and then automatically reconnects at the end of the run.

You can interrupt or abort an update by right-clicking the Solution cell. These options are
available during foreground, background and RSM updates.

Solution Properties: Use Setup Launcher Settings

The Properties pane of the Fluent Solution cell has a toggle that controls whether the solution
uses settings from the setup launcher. When Use Setup Launcher Settings is checked, the
launcher settings are copied from Setup component to Solution component. This copying also
happens any time you change the launcher settings in setup. When Use Setup Launcher Settings
is cleared, the Solution cell's launcher settings are available:

Setting Name Default Applicable to Remote Solve

Manager (RSM)
General
Precision Single Precision Yes
Show Launcher at Enabled No
Startup
Display Mesh After Enabled Yes
Reading
Embed Graphics Enabled Yes
Window
Use Workbench Color Enabled Yes
Scheme
Set up Compilation Enabled No
Environment for UDF
Use Job Scheduler Disabled No
Run Parallel Version The initial default execution mode Yes
(Serial / Parallel) is based on the

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
348 of ANSYS, Inc. and its subsidiaries and affiliates.
 Submitting Fluids Jobs to Remote Solve Manager

Setting Name Default Applicable to Remote Solve

Manager (RSM)
run settings. The initial number of
processes in RSM is based on the
Number of Processors option in
the run settings: if it is > 1, that
value is used, otherwise 2 is used.
If Run Parallel Version is not
enabled, then serial mode is
forced.
UDF Compilation Script $(FLUENT_ROOT)\$(ARCH)\udf.bat No
Path
Use Remote Linux Nodes Enabled No
Remote
Remote Polyflow Root None No
Path
Use Specified Remote Enabled No
Working Directory
Remote Working None No
Directory
Remote Spawn RSH No
Command
Use Remote Cluster Enabled No
Head Node
Remote Host Name None No
Parallel Run Settings
Number of Processors 1 No
Interconnect None No

Note:

You can enable Inter-

connect to be
available for
Polyflow RSM runs
by enabling Tools →
Options → Solution
Process → Show
Advanced Solver
Options. This setting
requires you to
ensure that the
remote Compute
servers can accept
the interconnect
that you

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 349
Working with Ansys Remote Solve Manager

Setting Name Default Applicable to Remote Solve

Manager (RSM)

specify—there is no
automatic checking
for such
compatibility.

To learn what values

are available, see
Starting Parallel
Ansys Fluent on a
Windows System
Using Command
Line Options in the
Fluent User's Guide.

MPI Type None No

Note:

You can enable MPI

Type to be available
for Polyflow RSM
runs by enabling
Tools → Options →
Solution Process →
Show Advanced
Solver Options. This
setting requires you
to ensure that the
remote Compute
servers can accept
the MPI Type that
you specify—there
is no automatic
checking for such
compatibility.

To learn what values

are available, see
Starting Parallel
Ansys Fluent on a
Windows System
Using Command
Line Options in the
Fluent User's Guide.

Use Shared Memory Disabled No

Machine Specification File containing the machine list No

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
350 of ANSYS, Inc. and its subsidiaries and affiliates.