Ansys Users Guide (351 480)

Download as pdf or txt
Download as pdf or txt
You are on page 1of 130

Submitting Fluids Jobs to Remote Solve Manager

Setting Name Default Applicable to Remote Solve


Manager (RSM)
Machine Filename None No
Solution Process
The Solution cell's Solution Process setting is always displayed; when Use Setup Launcher Settings
is checked, the option is read-only:
Update Option You can choose to Run in Foreground, Run in Background, or Submit
to Remote Solve Manager. When Submit to Remote Solve Manager is
chosen, options that are not applicable to RSM are hidden. Also, fluent-
launcher.txt does not contain options that conflict with RSM.

Submitting Icepak 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:

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

• You cannot submit jobs containing parametric trials to RSM.

• Convergence data is not plotted in Icepak on the local computer. The .res and
.uns_out files are written at the frequency specified in RSM settings. You must open
them in Icepak to view them.

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.

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

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.

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.

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

Note:

RSM updates Icepak with convergence plot data at the Progress Download Interval
specified in Workbench. Set the Progress Download Interval as needed prior to
starting the solution.

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. To re-run a solution
with the same model, run another solution in the same project, or run a restart solution, right-
click the Setup cell in Workbench and select Enable Update.

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

You can interrupt or abort an update by right-clicking the solution in the Workbench Job Monitor.
These options are available during background and RSM updates. To display the Job Monitor,
select Jobs → Open Job Monitor.

Submitting Forte Jobs to Remote Solve Manager


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

Note:

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

• If solving on a Linux RSM queue, upstream geometry changes must be configured to


occur before the RSM job. Select Pre-RSM Foreground Update to Geometry in the Project
Update settings of the Project Schematic.

• Forte's Monitor component does not provide live updates.

• You must specify at least two parallel processes.

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 white space of the Project Schematic 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 Parallel.

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

6. Specify the Number of Processes that you want to use to create the results file.

The number of process must be equal to or greater than two.

7. Update the project (p. 249).

Exiting a Project During a Remote Solve Manager Solution Cell Update


You can exit a project while a Solution cell update using Remote Solve Manager (RSM) is in progress
(one or more RSM jobs are running in the background and the Progress pane displays a project
status of Waiting for background task).

Note:

You cannot exit Workbench while job files are being uploaded. You can abort the job
during the upload by using the Stop button in the Progress bar.

The project must be saved at least once after the Solution cell update job was initiated for RSM jobs
to continue to run after you exit the project.

If you attempt to exit a project while a Solution cell update job is still running, the following scenarios
cause a dialog box to open, allowing you to specify whether you want to save the project before
exiting:

• You have never saved the project at any time after the same Solution cell update job was initiated.

• You have saved the project at least once after the same Solution cell update was initiated, but
results have been retrieved since your last save.

In either of these cases, if you do not save the project before exiting:

• All results retrieved since the last save operation are lost. You must save the project before
exiting if you want to keep any of results retrieved since the last save of the background
Solution cell update.

• If the project has never been saved after the Solution cell update job was initiated, all RSM
jobs are aborted and display a status of Cancelled and the cancelled icon ( ) in the RSM List
pane; the asterisk on the icon indicates that the job has also been released. When you reopen
the project, it is in the state of your last manual save.

• If the project has been saved at least once after the Solution cell update job was initiated,
RSM jobs that are queued and running continue to run after you exit. When you reopen the
project, you can resume the update of the pending jobs to reconnect and download the results.

If you do save the project before exiting:

• Retrieved results are saved to the project.

• RSM jobs that are queued and running will continue to run after you exit.

• Jobs where the results have been saved display a Status of Finished and the finished icon ( ) in
the RSM List pane; the asterisk on the icon indicates that the job has also been released.

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

• Jobs where results have not yet been saved are not released upon exit. When you reopen the
project, you can resume update of the pending jobs to reconnect and download the results.

Monitoring and Controlling Remote Solve Manager Jobs in Workbench


If you have chosen to submit project updates, design point updates, or component updates using the
Submit to Remote Solve Manager option, you can monitor their progress by displaying the Job
Monitor in Workbench.

To display the Job Monitor, select Jobs → Open Job Monitor, or click on the status
bar.

The Job Monitor provides a live view of what is happening in Remote Solve Manager (RSM) with the
current Workbench project.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
356 of ANSYS, Inc. and its subsidiaries and affiliates.
Monitoring and Controlling Remote Solve Manager Jobs in Workbench

The following information for each job is displayed:

• Job name

• Status (Running, Finished, Failed, and so on)

• Submission date/time

• Owner

• RSM queue

• HPC configuration

• HPC queue

Clicking on a job displays a detailed job log in the lower pane.

You can perform the following actions:

• To hide design point updates in the job list, disable the Include Design Point Jobs check box.

• To view a job report for a specific job, select the job in the Jobs pane. The report is displayed in the
Details pane.

• To save a job report to a file, click in the Details pane, then accept or specify the save location,
filename, and content to include:

You can use the context-sensitive menus in the Jobs pane and Details pane to perform a variety of
actions. For example, you can customize the job list display, and perform actions on a job such as Abort
or Interrupt.

Related topics:
Using the Taskbar Icon
Viewing the Status of Jobs
Controlling the Display of the Job List
Performing Job Actions
Controlling the Display of Job Details

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

Using the Taskbar Icon


When you launch the Job Monitor, a job monitor icon is also displayed on your Windows taskbar. If
you subsequently minimize the Job Monitor window, you can quickly restore it by clicking the taskbar
icon.

Viewing the Status of Jobs


The status of each job is indicated in the Status column in the Jobs pane, and by a unique icon at
the beginning of the job entry. For jobs that have completed, the Status column and icon indicate
the final status of the job. The addition of an arrow symbol to the final status icon indicates that the
job has been released.

Status Description Icon Released Icon


Input Job is being uploaded to the cluster.
Pending
Queued The job has been placed in the cluster queue and is
waiting to run.
Running Job is running.
Cancelled Job has been terminated using the Abort option.

Also applies to jobs that have been aborted


because you exited a project without first
performing one of the following actions:

• Saving the project since the update was


initiated

• Saving results retrieved since your last save

Finished Job has completed successfully.

Also applies to jobs that have been terminated


using the Interrupt option or for which you have
saved results prior to exiting the project.
Failed Job has failed.

May be applied to jobs that cannot be cancelled


due to fatal errors.

Controlling the Display of the Job List


You can sort the job list by job name, status, owner, and so on by clicking on the appropriate column
header in the Jobs pane. Clicking on the same column header again reverses the sort order.

If you right-click any column header, a context menu is displayed which contains the following options:

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
358 of ANSYS, Inc. and its subsidiaries and affiliates.
Monitoring and Controlling Remote Solve Manager Jobs in Workbench

Select All Selects all jobs in the list.


(Ctrl+A)
Scroll to Returns you to the beginning of the job list.
Top
Scroll to Takes you to the end of the job list.
Bottom
View Line Toggles the display of numbers at the beginning of
Numbers each entry in the job list.

Performing Job Actions


If you right-click a job in the Jobs pane, a context-sensitive menu is displayed that contains the fol-
lowing options:

Abort Immediately terminates a running job. Enabled only if a running job is


selected.

Jobs terminated via this option will have a Status of Canceled in the
Jobs pane.
Interrupt Terminates a running job. Enabled only if a running job is selected.

Jobs terminated via this option will have a Status of Finished in the
Jobs pane.
Remove Deletes the selected job or jobs from the Jobs pane. Enabled only if a
completed job is selected.

Cannot be used on a running job.

Controlling the Display of Job Details


When you select a job in the Jobs pane, a corresponding job log is displayed in the Details pane.
The log automatically scrolls to the bottom to keep the most recent messages in view.

If you right-click the job log, a context-sensitive menu is displayed which contains the following options:

Copy Copy selected text in the Details pane.

Alternatively, you can use the Ctrl+C key combination.


Select All Select all of the text in the Details pane.

Alternatively, you can use the Ctrl+A key combination.


Save Job Report... Save the job log to a file.

The job report includes job details and the contents of the job log shown
in the Details pane.

To save the job report:

1. Specify the following report preferences:

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

• Include Debug Messages: adds debugging messages to the report

• Include Log Time Stamp: adds a log time stamp to the report

• Include Line Numbering: displays line numbering in the report

2. Click Browse

3. In the File name field, type in the name of the report (RSMJob.html
by default).

4. Select the report format (HTML or text)

5. Click Save.

View Line Numbers Toggle the display of line numbers at the beginning of each line in the job log.
View Time Stamps Toggle the display of time stamps at the beginning of each line in the job log.
View Exclusively Only display file-related messages in the job log, such as those relating to file
File Messages transfers.
View Debug Toggle the display of debugging information in the job log.
Messages
SubTask Filters Filters the content of the job log by design point sub-task. This option is only
displayed when the job contains design points.
Scroll to Top Go to the top of the job log.
Scroll to Bottom Go to the bottom of the job log.

Updating Design Points in Remote Solve Manager


Remote Solve Manager (RSM) can integrate with established compute clusters or a third-party Cloud
using configurations defined in RSM. When these configurations are made available to the RSM client
(your local computer), the RSM queues defined in those configurations are available in Workbench Each
RSM queue is associated with a specific HPC queue defined on the cluster/portal side, making it possible
for the update to be submitted to remote HPC resources. For more information see Working with Ansys
Remote Solve Manager (p. 327).

Important:

• If you are sending design point update jobs to a remote compute 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. For more information, see Setting HPC User Preferences.

• When design points are configured to be updated using RSM, the Solution cell cannot
also be updated using RSM. To update design points in RSM, change the Solution cell
update settings by setting the Update Option property to Run in Foreground.

Related topics:

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
360 of ANSYS, Inc. and its subsidiaries and affiliates.
Updating Design Points in Remote Solve Manager

Submitting Design Points to Remote Solve Manager


Updating Geometry Locally Before Submitting to Remote Solve Manager
Design Point License Sharing
Tracking Licenses
Using Upfront License Checkouts for Design Point Updates
Aborting or Interrupting an RSM Design Point Update
Exiting a Project during an RSM Design Point Update
Suspending and Resuming Collection of RSM Design Point Results
Product-Specific Limitations

Submitting Design Points to Remote Solve Manager


To submit design points to Remote Solve Manager (RSM):

1. To view the Design Point Update Process settings, right-click the Parameter Set bar and select
Properties.

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 Remote Solve Manager.

3. Specify an available RSM Queue.

4. From the Design Point Initialization drop-down list, select one of the following options:

• Update From Current: Causes each design point to be initialized from the Current design
point.

• Update Design Points in Order: Causes each design point to be initialized from the previous
design point.

5. To update your geometry locally before submitting the design points to RSM, from the Pre-RSM
Foreground Update drop-down list, select Geometry.

Otherwise, leave the option as None.

6. If you selected Geometry in the previous step, to retain the results from the geometry update,
from the Retain Partial Update drop-down list select Geometry.

7. For the Component Execution Mode property, select one of the following options:

• Serial: All components participating in the update are run in serial mode.

• Parallel: All components participating in the update that support this setting are run in parallel
mode.

Submitting a design point update to RSM is supported by the Solution (or Analysis) component
update for the Mechanical APDL, Mechanical, Fluent, CFX and Polyflow solvers. These settings
override any parallel or serial settings defined at the component level. When updating a compon-

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

ent, system, or project, the Parameter Set properties for a design point update are ignored. The
following product specific settings are overridden for a design point update in RSM:

Product Ignored Properties


CFX-Solver Manager or CFX-Pre Solu- • All settings under the Parallel Environment tab.
tion cell
• Run mode

• All host information and partition weighting

Fluent Solution cell • Use Job Scheduler

• Run Parallel Version

• Number of Processes

• Use Shared Memory

• Machine Specification

• Machine List

Note:

The following properties remain enabled


in all situations, if set:

• Interconnect

• MPI Type

Advanced section of a Mechanical • Distributed Solution (if possible)


Solve Process Setting
• Max number of utilized cores

Mechanical APDL Analysis cell • Processors

• Distributed

• MPI Type

• Machine list

Polyflow Options accessed by Solu- Number of Processes


tion cell preferences

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
362 of ANSYS, Inc. and its subsidiaries and affiliates.
Updating Design Points in Remote Solve Manager

8. In the Number of Jobs to be Created field, type the number of RSM jobs to create. The default
is 1.

Note:

License sharing only works within a job. If you create multiple jobs, you cannot share
licenses across them, so we recommend creating multiple tasks within one job to take
advantage of license sharing.

9. In the Number of Tasks Per Job field, type the number of design point update tasks to run per
RSM job. The default is 1.

The numbers you enter in steps 8 and 9 divide the total number of design points you are updating
into individual tasks, with each task running a separate Workbench session. Then the tasks are
divided up into one or more RSM jobs.

For example, you are updating 20 design points and request two RSM jobs and five tasks per
job. Each job will contain five tasks, and each task will update two design points. A total of 10
Workbench sessions will be created.

10. If you selected Parallel in step 6, in the Number of Cores Required Per Task field, type the
number of cores to use on the cluster machine for each task. The default is 2.

The total number of cores requested to run the entire update is calculated using the formula
(Number of tasks * Number of Cores)+1. The additional core is for the head task, which is used
to create all of the sub-tasks.

11. For the Retained Design Point property, select one of the following options:

• Update parameters (default): Only parameters are updated for retained design points. If a
component is not needed to get the value of an output parameter, it is not updated.

• Update full project: Full project is updated for retained design points. Use this setting if you
want to generate reports, or other content, from components that do not produce output
parameters.

12. The Remote Job Status Check Interval in Seconds field sets the number of seconds between
each query to RSM for the design point update job status. To increase or decrease this interval,
enter the number of seconds into the field. The default is 20.

13. To set upfront license checkouts, click Select Licenses. For more details, see Using Upfront License
Checkouts for Design Point Updates (p. 366).

14. Save the project.

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

15. Update the design points.

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

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

Updating Geometry Locally Before Submitting to Remote Solve Manager


You can update your geometry locally before submitting design point updates to Remote Solve
Manager (RSM). Do this when:

• Design points are being updated simultaneously in RSM. The geometry update infrastructure does
not support simultaneous design point updates in the same source geometry.

• The compute cluster cannot access the required CAD licenses.

• The compute cluster does not have a CAD program installed

Performing a Pre-RSM Geometry Update


This is the most common workflow used to update geometry locally.

To perform a pre-RSM geometry 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. Set the Update Option to Remote Solve Manager and then specify an available RSM Queue.

3. In the Design Point Update Process settings, set Pre-RSM Foreground Update to Geometry.

Note:

If the project includes a Geometry component and you have set Remote Solve Manager
(Legacy) Job Submission to either One Job for Each Design Point or Specify Number
of Jobs (with the value set to greater than 1), the setting does not apply to the geo-
metry update. The geometry is updated locally in the foreground before your design
points jobs are sent to RSM.

4. Update the remaining Design Point Update Process settings as required.

For detailed setting descriptions, see Submitting Design Points to Remote Solve Manager (p. 361).

5. Save the project (p. 275).

If you are working in an archived project, you must save the active project.

6. Update the design points (p. 313).

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
364 of ANSYS, Inc. and its subsidiaries and affiliates.
Updating Design Points in Remote Solve Manager

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

Performing a Geometry-Only Design Point Update


This is a non-standard workflow, but it allows you to move the geometry updates to the compute
cluster manually.

To perform a geometry-only design point 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.

5. Save the project (p. 275).

If you are working in an archived project, you must save the active project.

6. Update the design points (p. 313).

7. Transfer the project files from the local machine to the RSM compute cluster.

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

Design Point License Sharing


When Workbench design point updates are submitted to Remote Solve Manager on a cluster, you
can specify the number of tasks in a RSM job to update concurrently. You can also specify multiple
jobs to be submitted to reduce the individual job size.

Licenses are not shared between different RSM jobs.

However, licenses are shared between concurrent tasks within the same job using HPC licenses, allowing
you to leverage standard HPC licenses instead of extra solver licenses. Each task requires eight HPC
increments or one HPC Pack increment. Similar to non-parametric simulations, each task includes four
parallel cores. Additional HPC parallel cores are shared across all tasks, using the same HPC rules. All
licenses that are consumed during a RSM job are held for the duration of the job, based on the
maximum count of each license.

If HPC licenses are not available at all, or there are not enough available, solver licenses are used in-
stead.

You can use the Ansys Parametric Licensing Calculator (https://ansys.com/parametric) to determine
the number of HPC Workgroup or HPC Pack licenses required.

For more detailed information on HPC licences, see HPC Licensing in the Ansys, Inc. Licensing Guide.

Tracking Licenses
Workbench tracks licenses that are used during an update. You can see what licenses were used for
any component by viewing that component's properties. The Last Update Used Licenses property
displays which licenses were used. You may find it useful to run the update of at least one design
point as you normally would and then review the licenses that were used so that you know which
licenses are needed for a future study. License usage is tracked only for an update operation in a
component. It is not tracked if a component becomes up-to-date as the result of an edit operation.
License usage is not tracked for DesignXplorer components or any parametric components.

License tracking may not return the information in some cases, for example if a component editor
was open for viewing or editing at the time of the update. In this case, Not Applicable is shown for
Last Update Used Licenses, even though a license is used. To ensure that tracking captures inform-
ation for all components, close all component editors before updating.

Note:

License tracking can be turned off by your corporate license administrator. If you run a
study and do not see which licenses were used, contact your license administrator.

Using Upfront License Checkouts for Design Point Updates


Ansys Common Licensing eliminates the need to reserve licenses ahead of the update. The license
sharing based on HPC context automatically starts when design points are updated using Remote
Solve Manager. In some situations, you may need to have your design point RSM job fail on startup
if certain set of licenses are not available. To do this, you can specify licenses that are checked out at
the start of RSM job execution, so that the job fails early if there are insufficient licenses. If more licenses

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
366 of ANSYS, Inc. and its subsidiaries and affiliates.
Updating Design Points in Remote Solve Manager

are required during the update than were checked out upfront, they are checked out automatically
based on HPC context.

To use upfront license checkouts:

1. To view the Design Point Update Process settings, right-click the Parameter Set bar and select
Properties.

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 Remote Solve Manager.

3. Click Select Licenses.

4. In the Select Licenses dialog box:

a. From the Available Licenses list, select one or more licenses.

You can select multiple licenses at one time by holding down the Ctrl key as you click each
license.

The Available Licenses list displays licenses currently available on the license server connected
to the Workbench session, which may or may not be the license server connected to the
RSM cluster.

b. Click Add.

The licenses you have selected appear in the Selected Licenses for Upfront Checkout
pane.

c. To see which licenses were used for this Workbench project in previous updates, switch to
the Used Licenses tab.

You can add licenses to the selection from this list as well.

d. To save the selection and close the dialog, click OK.

The selected licenses are not checked out at this time. License checkout occurs only when
you begin the update.

You may need to include a Geometry license as part of upfront-checkout licenses even when the
Geometry component is not parameterized and is up-to-date, if either of the following situations is
true:

• If the project contains CAD geometry or any other geometry that is not managed by the Geometry
component but rather by a downstream Model or Mesh component, and the geometry is paramet-
erized using the Model or Mesh component.

• If an Engineering Data component is parameterized and shares a model or mesh downstream with
a non-parameterized Geometry component.

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

Aborting or Interrupting an RSM Design Point Update


You can abort or interrupt an RSM update that is in progress.

To abort or interrupt the update:

1. In the Progress pane, while the Status column displays the message Waiting for back-

ground task, click the stop button ( ) in the Progress column.

2. In the dialog box, select one of the following options:

• To stop the RSM job and return no data to the project, click Abort.

• To interrupt the RSM job and return any available data to the project, click Interrupt.

• To let the update continue and close the dialog box, click Cancel.

Exiting a Project during an RSM Design Point Update


You can exit a project while an RSM design point update is in progress. During the update, while the
one or more RSM jobs are running in the background, the Progress pane displays a project Status
of Waiting for background task.

Note:

• If you have submitted the Update All Design Points operation to RSM and are unable
to exit the project because Workbench remains busy, see Suspending and Resuming
Collection of RSM Design Point Results (p. 369).

• You cannot exit Workbench while job files are being uploaded. However, you can abort
the job during the upload by clicking the stop button ( ) in the Progress bar.

For RSM jobs to continue to run after you exit the project, the project must be saved at least once
after the design point update job was initiated.

If you attempt to exit a project while a design point update job is still running, the following scenarios
cause a dialog box to open, allowing you to specify whether you want to save the project before
exiting:

• You have never saved the project at any time after the same design point update job was initiated.

• You have saved the project at least once after the same design point update was initiated, but
design point results have been retrieved since your last save.

In either of these cases, if you do not save the project before exiting:

• All design point results retrieved since the last Save operation are lost. However, if the project has
been saved at least once since the update job was initiated, the results can be retrieved again
when the project is reopened.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
368 of ANSYS, Inc. and its subsidiaries and affiliates.
Updating Design Points in Remote Solve Manager

• If the project has never been saved after the update job was initiated, all RSM jobs are aborted
and show a Status of Cancelled. The cancelled icon ( ) displays in the RSM List pane. The asterisk
on the icon indicates that the job has also been released. When you reopen the project, it is in the
state of your last manual save.

If you do save the project before exiting:

• Retrieved design point results are saved to the project.

• RSM jobs that are queued and running continue to run after you exit.

• Jobs where the results have been saved show a Status of Finished. The finished icon ( ) displays
in the RSM List pane. The asterisk on the icon indicates that the job has also been released.

• Jobs where results have not yet been saved are not released upon exit. When you reopen the
project, you can resume update of the pending jobs to reconnect and download the results.

Suspending and Resuming Collection of RSM Design Point Results


When the Update All Design Points operation has been submitted to RSM, Workbench may be col-
lecting intermediate and final results and not allow you to exit the session. To pause the data collection
so you can exit the Workbench session, select Tools → Suspend Collection of RSM Results.

When you exit the project, results are saved according to the criteria described in Exiting a Project
during an RSM Design Point Update (p. 368).

Note:

The Suspend Collection of RSM Results option is also available during a project update
in RSM. However, because only the current design point is being updated and RSM collects
results only at the end of the update process, this option has no impact on the project
update.

To resume the collection of design point data, select Tools → Resume Collecting RSM Results. The
project reopens in the same state it was in when it closed. Once all the design points have been up-
dated, all of the suspended results are collected and then updated to the project at the same time.

It is not necessary to use the Resume Collecting RSM Results option. The collection and update
happen automatically when all jobs have been completed.

Product-Specific Limitations
Some products have additional limitations when submitting design points updates to RSM:

Ansoft
Projects that include Ansoft systems return updated parameter values but do not return the detailed
solution for the current design point.

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

Mechanical
Design point updates in RSM can fail for a class of problems (typically involving a Structural system
linked to a Modal or other type of Mechanical system) that meet the following criteria:

• A non-parameterized upstream Mechanical system provides solution data to a parameterized


downstream Mechanical system and both systems share the same geometry/model.

• Updates are performed via a pre-RSM local update.

The parameters for some of the design points are not computed and are marked as errors in the
design points table.

Workarounds:

• Select the Enable Legacy Solve check box (Tools → Options → Mechanical).

• In the Parameter Set properties, set Pre-RSM Foreground Update to None and Job Submission
to One Job for All Design Points.

Third-Party CAD Systems


Projects that include geometry parameters that rely on third-party CAD systems do not update the
geometry unless the CAD system is accessible on the execution node.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
370 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with Design Point Service
Note:

The Ansys Distributed Compute Services (DCS) application has evolved into a newer family
of technology components represented by Ansys HPC Platform Services (HPS) (p. 381). You
can still submit to DCS from Workbench in this release, but DCS will be removed in a future
release.

Design Point Service (DPS) is part of Distributed Compute Services (DCS). DPS can quickly and efficiently
evaluate tens of thousands of design points using multiple compute resources. It supports submission
of design point updates on local machines and on HPC clusters using Remote Solve Manager (RSM).

• For information about DPS, see the DCS for Design Points Guide.

• For information about RSM, see Working with Ansys Remote Solve Manager (p. 327).

The following steps provide a quick start for a single-user desktop scenario. They summarize how to
set up a Workbench project to use DPS for design point updates.

1. If DCS is not installed on your machine, install it using the Ansys installer. For more information,
see DCS Installation in the DCS for Design Points Guide.

2. Create a Workbench project, identify input and output parameters for the simulation, and insert
a few design points.

The remaining steps summarize the detailed information given in Setting Up a Workbench
Project to Use DPS (p. 372) and Submitting Design Point Updates to DPS (p. 374).

3. In the Project Schematic, right-click the Parameter Set bar and select Properties.

4. Under Solution Process, set Update Option to Submit to Design Point Service (DPS).

In a single-user desktop scenario, you can use the defaults for the other properties under this
heading to have a local evaluator update the design points that are sent to DPS.

5. Under Design Point Update Process, set Component Execution Mode to Parallel and Number
of Processes to 2 or more, depending on your machine.

6. Click Update All Design Points and, when prompted, enter DCS credentials to sign in and
send the design points to DPS for evaluation. Default system administrator account information
for all DCS services is given in DCS Installation.

7. Either view results as they are written back to the Workbench project or, in the status bar, click
the button for opening the DPS web app ( ), where you can view, filter, sort, and compare
the design points in the connected DPS project. For more information, see DPS Web App in
the DCS for Design Points Guide.

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

Related topics:
Setting Up a Workbench Project to Use DPS
Submitting Design Point Updates to DPS
Submitting Project Updates to DPS
Accessing the DPS Web App from a Workbench Project
Importing DPS Design Points into a Workbench Project
Evaluating Design Points or Project Updates in Multiple Process Steps

Setting Up a Workbench Project to Use DPS


In the properties for the Workbench Parameter Set bar or Project Schematic, you set Update Option
to Submit to Design Point Service (DPS). When you update design points or the project, the Workbench
project definition and either unsolved design points or project updates are sent to DPS for evaluation.

1. In the Project Schematic, right-click the Parameter Set bar or the white space of the Project
Schematic and select Properties.

2. In the Properties view, set Update Option to Submit to Design Point Service (DPS) and then
set the other properties appropriately.

See the following descriptions for DPS-related properties:

Property Description
Update When set to Submit to Design Point Service (DPS), the request for updating one or
Option more design points in the Parameter Set bar, any cell in a DesignXplorer system, or a
project update is sent to DPS. For this setting, Workbench checks to see if the URL setting
for the DCS server is valid and if the server is responding. If a problem exists, a dialog
box opens, asking whether you want to start a local server or supply a valid URL to a
remote server.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
372 of ANSYS, Inc. and its subsidiaries and affiliates.
Setting Up a Workbench Project to Use DPS

Property Description
Server URL URL for starting the DCS server.

• The URL for starting a local DCS local server is https://localhost/dcs on


Windows or https://localhost:8443/dcs on Linux.

• The URL for starting a remote DCS server on Windows is https://host-


name/dcs or https://IP_Address/dcs.

• The URL for starting a remote DCS server on Linux is https://host-


name:port/dcs or https://IP_Address:port/dcs.

Database Name of the DPS project to which this Workbench project connects. The DPS project
Name stores and manages the project definition and design points. If you leave this property
blank, the DPS project is given the same name as the Workbench project.
Auto-Start Whether to automatically start an evaluator on the local machine when updates are
Local requested. This check box is selected by default. If you clear this check box, you can
Evaluator start the evaluator on the local machine by going to the Windows Start menu and
selecting Ansys 2024 R1 → DC Evaluator (DCE) 2024 R1. You can also start it from the
command line by typing dclauncher.exe start evaluator.
Execution Maximum execution time in which to update one design point or run the project update.
Time Limit If the update does not complete within this time, the evaluation is terminated. In the
(seconds) DPS web app, the design point is then assigned to the timeout status filter. For more
information, see DPS Web App in the DCS for Design Points Guide.
Update Whether to distribute the computing for different tasks between different applications
Design Points and evaluators. For example, the project can use Ansys Discovery SpaceClaim to update
in Steps the geometry and Ansys Fluent to generate results. SpaceClaim could be running on a
Windows machine while Fluent is running on a Linux cluster, cloud service, or local
machine. For more information, see Evaluating Design Points or Project Updates in
Multiple Process Steps (p. 378).
Component Specifies whether to run the solution in serial or in parallel.
Execution
Mode • When Serial is selected (default), updates are executed on only one CPU core at
a time.

• When Parallel is selected, updates are executed on multiple CPU cores.

Number of Specifies the default number of processes to use if you are running updates in parallel.
Processes This property must be set to 2 or greater.

Note:

In Tools → Options → Distributed Compute Services, you must set a default URL for
starting the DCS server and specify whether to auto-start a local evaluator. For more
information, see Distributed Compute Services (p. 444). Here in the Properties pane for
the Parameter Set, you can change these inherited properties for this particular project.

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

Submitting Design Point Updates to DPS


When the Update Option is set to Submit to Design Point Service (DPS), any update of design points
from either the Parameter Set bar or a DesignXplorer system cell will send the Workbench project
definition and unsolved design points to DPS for evaluation. The Workbench project definition includes
the parameter definitions, workflow definition, and project files.

Clicking Update All Design Points in the Parameter Set bar opens a dialog box. The prompt depends
on if there are design points that require updating and if the DPS project exists.

• If there are no design points that require updating, you are told that the output parameters for
all design points are up-to-date.

• If the Workbench project has unsaved changes, you are told that you must save the Workbench
project to proceed. Clicking Save and Proceed saves the project and sends the project definition
and unsolved design points to the DPS project.

• If the DPS project exists but is not the same as the last one synced from the Workbench project,
you are asked if you would like to replace the project and its design points, update the project
but keep its design points, or create a new project. If you click Create new, a dialog box opens
for entering a different name for the DPS project. The name can contain only letters and digits.

• If the DPS project cannot be found because it has either been deleted or moved to a different
server, you are asked if you want to create a new DPS project with the same name. Clicking
Create sends the Workbench project and design points to the new DPS project.

As unsolved design points are sent to the DPS project, evaluators pick them up and run the simulation
tasks, writing results back to the Workbench project as the evaluations are completed.

Throughout this process, Workbench displays processing information in the status bar and the Progress
view. In the status bar, you can click the button for opening the DPS web app ( ). The button displays
the name of the connected DPS project. Or, from the Jobs menu, you can select Open Design Point
Service Web App.

In the DPS web app, you can view project information, configure the project, and filter, sort, and compare
design points. For more information, see DPS Web App in the DCS for Design Points Guide.

Note:

If you exit Workbench before the update finishes, evaluators continue to update the design
points in the DPS project. When you next open the Workbench project, it automatically syncs
the design points in the Workbench and DPS projects. If you later make parameter or project
changes in the Workbench project, selecting Jobs → Sync with Design Point Service pushes
these changes to the DPS project.

Submitting Project Updates to DPS


When the Update Option is set to Submit to Design Point Service (DPS) and you update the project,
the Workbench project definition and project updates are sent to DPS for evaluation. The Workbench
project definition includes the workflow definition and project files.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
374 of ANSYS, Inc. and its subsidiaries and affiliates.
Accessing the DPS Web App from a Workbench Project

To submit project updates to DPS:

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

2. Update the project:

• From the menu bar select Tools → Update Project.

• On the Project tab toolbar click Update Project.

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

The project update starts. Throughout this process, Workbench displays processing information in the
status bar and the Progress view. In the status bar, you can click the button for opening the DPS web
app ( ). The button displays the name of the connected DPS project. Or, from the Jobs menu, you can
select Open Design Point Service Web App.

In the DPS web app, you can view project information and configure the project. For more information,
see DPS Web App in the DCS for Design Points Guide.

Note:

If you exit Workbench before the update finishes, evaluators continue the process in the DPS
project. When you next open the Workbench project, it automatically syncs the changes in
the Workbench and DPS projects. If you later make parameter or project changes in the
Workbench project, selecting Jobs → Sync with Design Point Service pushes these changes
to the DPS project.

Accessing the DPS Web App from a Workbench Project


When a Workbench project has an established DPS project connection, you can access the DPS web
app to view DPS project information using one of these methods:

• In the status bar, click the button for opening the DPS web app ( ). The button displays the
name of the connected DPS project. If the Workbench project is not connected to a DPS project,
the button displays No DPS Connection.

• Select Jobs → Open Design Point Service Web App.

You are taken to the Design Points tab for this DPS project so that you can view design point inform-
ation.

Note:

• If you try to access the DPS web app before a DPS project connection is established,
you are taken to the DPS web app's Projects page, where you can click the name of
a DPS project to go to its Design Points tab.

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

• If you want to sign out of DCS from a Workbench project with a DPS connection, select
Jobs → Sign out from Distributed Compute Services.

Importing DPS Design Points into a Workbench Project


If you have evaluated design points in a DPS project, you can import any design points of interest into
the Workbench project for further analysis or review:

1. On the Project Schematic, open either the Parameter Set bar or the DesignXplorer cell into
which to import DPS design points.

2. In the Table pane, right-click and select one of the following, depending on your location:

• Import from Design Point Service: Select to import DPS design points into the design
points table for the Parameter Set bar or into a DesignXplorer custom DOE or parameters
correlation.

• Import Refinement Points from DPS: Select to import DPS design points into the re-
finement points table in a DesignXplorer response surface.

• Import Verification Points from DPS: Select to import DPS design points into the
verification points table in a DesignXplorer response surface.

• Import Custom Candidate Points from DPS: Select to import DPS design points into
a custom candidate points table in a DesignXplorer optimization.

Note:

The above options are also available on the context menu for the Outline pane
if you right-click a node that supports importing design points from DPS.

The Import from Design Point Service window opens.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
376 of ANSYS, Inc. and its subsidiaries and affiliates.
Importing DPS Design Points into a Workbench Project

To select the DPS design points to import, you can specify design point IDs, enter a query string,
or enable filters. When you place the mouse cursor over the description for the field in which
you enter IDs or a query string, the tooltip displays usage examples.

By default, the maximum number of design points returned from a query or from enabled filters
is 1000. However, before querying or filtering, you can change the value for Max Results. This
field appears in the upper right corner, below the Search button.

3. Select the design points to import using one of these methods:

• Specify design points IDs, separating them with commas, and click Search.

• Enter or select a previously entered query string and click Search.

• Click the buttons for filters to switch between enabling and disabling them. Choices are
for the evaluated, timeout, and failed status filters and the star filter.

The heading for the Design Points pane displays the total number of design points selected
in parentheses. The table displays these design points. Below the table, the buttons on the left
clear the table of results and clear the Status pane of processing information. On the right, the
Import button imports the selected design points into the Parameter Set bar.

4. Once the table displays the design points that you want to import, click Import.

The window closes and a progress bar appears.

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

If the DPS project and Workbench project have differences beyond just design points, a dialog box in-
dicates that imported design points will be set out-of-date and asks if you want to continue. If you click
Yes, before it imports the design points, DesignXplorer parses and validates the design point data. For
more information, see Parsing and Validation of Design Point Data in the DesignXplorer User's Guide.

The design points that are imported into the Workbench project from DPS are not linked to the design
points in DPS. You can perform standard operations on an imported design point, such as setting it as
the current design point.

Although output parameter values for imported design points are read-only, you can set them as editable.
For more information, see Editable Output Parameter Values in the DesignXplorer User's Guide.

Evaluating Design Points or Project Updates in Multiple Process Steps


You can set up a Workbench project to have DCS evaluate design points or project updates in multiple
process steps (tasks) on multiple machines. For example, you might be using standalone SpaceClaim,
third-party geometry and CAE tools plus an Ansys solver tool, and a Python postprocessing tool.

When running simulations in a mixed environment:

1. In the Project Schematic, right-click the Parameter Set bar or the white space of the Project
Schematic and select Properties.

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

3. Select Jobs → Sync with Design Point Service to send the updated simulation workflow
definition to the DPS project.

4. In DPS, go to the project's Design Points table and click the Configurations tab.

5. Open the appropriate configuration's details view.

In the task pane on the right, two tasks are now visible:

• Workbench_Geometry

• Workbench_Solution

6. Define each of these tasks.

Example
Assume that the geometry step requires SpaceClaim (SCDM), which runs on a Windows machine, and
the solution step requires a custom solver (my_solver), which runs on a Linux machine.

Only an evaluator with the SCDM capability can update the geometry, and only an evaluator with the
my_solver capability can update the solution.

For the geometry step, the default settings sent from the Workbench project should be correct. For the
solution step, because only an evaluator with the my_solver capability on the Linux machine can
update the solution, you would have to add my_solver as a capability and click Save.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
378 of ANSYS, Inc. and its subsidiaries and affiliates.
Evaluating Design Points or Project Updates in Multiple Process Steps

After you submit a design point update to DPS, in the design point's Viewing Design Point Details, the
Evaluation area will display information for the two tasks that have been run on two different evaluators.

Note:

While there cannot be more than two tasks when design points are updated from a Work-
bench project, you can use the lightweight DCS Python Client to script any number of process
steps.

When an evaluation has multiple tasks, they run sequentially by default. For example, based on the
example, the geometry is updated first, and the solution is updated second. However, when defining
a task, you can use Execution Level in the Requirements area to specify the sequence for executing
the task when multiple tasks are defined. All tasks set to 0 can be evaluated at the same time, supporting
an interesting workflow if there are multiple unrelated load cases.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 379
Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
380 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with Ansys HPC Platform Services
Ansys HPC Platform Services is a set of technology components designed to help you manage the exe-
cution of simulations while making use of your full range of computing assets. Together, these compon-
ents form a framework for executing HPC workflows with ease and efficiency.

The following topics cover how to set up and submit to Ansys HPC Platform Services from Workbench.
For more details on using Ansys HPC Platform Services, see the Ansys HPC Platform Services Guide on
the Ansys Help website.

Related topics:
Setting Up a Workbench Project to Use Ansys HPC Platform Services
Submitting Design Point Updates to Ansys HPC Platform Services
Submitting Project Updates to Ansys HPC Platform Services
Accessing the Ansys HPC Job Manager Web App from a Workbench Project
Importing Ansys HPC Platform Services Design Points Jobs into a Workbench Project
Evaluating Design Points or Project Updates in Multiple Process Steps
Resetting the Ansys HPC Platform Services Project ID

Setting Up a Workbench Project to Use Ansys HPC Platform Services


In the properties for the Workbench Parameter Set bar or Project Schematic, you set Update Option
to HPC Platform Services. When you update design points or the project, the Workbench project
definition and either unsolved design points or project updates are sent to Ansys HPC Platform Services
for evaluation.

1. In the Project Schematic, right-click the white space of the Project Schematic and select Properties.

2. In the Properties view, set Update Option to HPC Platform Services and then set the other
properties appropriately.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 381
Working with Ansys HPC Platform Services

See the following property descriptions:

Property Description
Update Option When set to HPC Platform Services, the request for updating one or more design
points in the Parameter Set bar or a project update is sent to Ansys HPC Platform
Services.
HPC Platform URL for connecting to Ansys HPC Platform Services.
Services URL
• The URL for a local server is https://localhost:8443/rep

• The URL for a remote server is https://hostname:port/rep or ht-


tps://IP_Address:port/rep.

HPC Platform When the project is submitted to HPC Platform Services, an ID for the project is
Services project created. You can reset (p. 387) this ID.
ID
Execution Time Maximum execution time in which to update one design point or run the project
Limit (seconds) update. If the update does not complete within this time, the evaluation is terminated.
In the HPC Job Manager web app, the design point is then assigned to the timeout
status filter. For more information, see Execution in the Ansys HPC Platform Services
Guide.
Update Design Whether to distribute the computing for different tasks between different applications
Points in Steps and evaluators. For example, the project can use Ansys Discovery SpaceClaim to
update the geometry and Ansys Fluent to generate results. SpaceClaim could be
running on a Windows machine while Fluent is running on a Linux cluster, cloud
service, or local machine. For more information, see Evaluating Design Points or
Project Updates in Multiple Process Steps (p. 387).
Component Specifies whether to run the solution in serial or in parallel.
Execution Mode
• When Serial is selected (default), updates are executed on only one CPU core
at a time.

• When Parallel is selected, updates are executed on multiple CPU cores.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
382 of ANSYS, Inc. and its subsidiaries and affiliates.
Submitting Design Point Updates to Ansys HPC Platform Services

Property Description
Number of Specifies the default number of processes to use if you are running updates in parallel.
Processes This property must be set to 2 or greater.

Note:

In Tools → Options → HPC Platform Services, you must set a default URL for connecting
to the server. For more information, see HPC Platform Services (p. 444). Here in the
Properties pane, you can change these inherited properties for this particular project.

Submitting Design Point Updates to Ansys HPC Platform Services


When the Update Option is set to HPC Platform Services, any update of design points from the
Parameter Set bar will send the Workbench project definition and unsolved design points to Ansys
HPC Platform Services for evaluation. The Workbench project definition includes the parameter definitions,
workflow definition, and project files.

Clicking Update All Design Points in the Parameter Set bar opens a dialog box. The prompt depends
on if there are design points that require updating and if the Ansys HPC Platform Services project exists.

• If there are no design points that require updating, you are told that the output parameters for
all design points are up-to-date.

• If the Workbench project has unsaved changes, you are told that you must save the Workbench
project to proceed. Clicking Save and Proceed saves the project and sends the project definition
and unsolved design points to the Ansys HPC Platform Services project.

• If the Ansys HPC Platform Services project exists but is not the same as the last one synced from
the Workbench project, you are asked if you would like to replace the project and its design
points, update the project but keep its design points, or create a new project.

• If the Ansys HPC Platform Services project cannot be found because it has either been deleted
or moved to a different server, you are asked if you want to create a new project with the same
name. Clicking Create sends the Workbench project and design points to the new Ansys HPC
Platform Services project.

As unsolved design points are sent to the HPC Platform Services project, evaluators pick them up and
run the simulation tasks, writing results back to the Workbench project as the evaluations are completed.

Throughout this process, Workbench displays processing information in the status bar and the Progress
view. In the status bar, you can click the button for opening the Ansys HPC Job Manager web app

( ). Or, from the Jobs menu, you can select Open HPC Job Manager.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 383
Working with Ansys HPC Platform Services

In the Ansys HPC Job Manager web app, you can view project information, configure the project, and
filter, sort, and compare design points. For more information, see Ansys HPC Job Manager Web App in
the Ansys HPC Platform Services Guide.

Note:

If you exit Workbench before the update finishes, evaluators continue to update the design
points in the HPC Platform Services project. When you next open the Workbench project, it
automatically syncs the design points in the Workbench and HPC Platform Services projects.
If you later make parameter or project changes in the Workbench project, selecting Jobs →
Sync with HPC Platform Services pushes these changes to the HPC Platform Services project.

Submitting Project Updates to Ansys HPC Platform Services


When the Update Option is set to HPC Platform Services and you update the project, the Workbench
project definition and project updates are sent to Ansys HPC Platform Services for evaluation. The
Workbench project definition includes the workflow definition and project files.

To submit project updates:

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

2. Update the project:

• From the menu bar select Tools → Update Project.

• On the Project tab toolbar click Update Project.

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

The project update starts. Throughout this process, Workbench displays processing information in the
status bar and the Progress view. In the status bar, you can click the button for opening the Ansys HPC

Job Manager web app ( ). Or, from the Jobs menu, you can select Open HPC Job
Manager.

In the Ansys HPC Job Manager web app, you can view project information and configure the project.
For more information, see Ansys HPC Job Manager Web App in the Ansys HPC Platform Services Guide.

Note:

If you exit Workbench before the update finishes, evaluators continue the process in the
Ansys HPC Platform Services project. When you next open the Workbench project, it auto-
matically syncs the changes in the Workbench and Ansys HPC Platform Services project. If
you later make parameter or project changes in the Workbench project, selecting Jobs →
Sync with HPC Platform Services pushes these changes to the HPC Platform Services project.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
384 of ANSYS, Inc. and its subsidiaries and affiliates.
Importing Ansys HPC Platform Services Design Points Jobs into a Workbench Project

Accessing the Ansys HPC Job Manager Web App from a Workbench Project
When a Workbench project has an established Ansys HPC Platform Services project connection, you
can access the Ansys HPC Job Manager web app to view project information using one of these methods:

• In the status bar, click the button for opening the Ansys HPC Job Manager web app

( ). If the Workbench project is not connected to an Ansys HPC Platform Services


project, the button displays No HPC Platform Services Connection

( ).

• Select Jobs → Open HPC Job Manager.

You are taken to the Jobs page for this Ansys HPC Platform Services project.

Note:

• If you try to access the Ansys HPC Job Manager web app before a project connection
is established, you are taken to the web app's Projects page, where you can click the
name of a project to view its details.

• If you want to sign out of Ansys HPC Platform Services from a Workbench project
with a Ansys HPC Platform Services connection, select Jobs → Sign out from HPC
Platform Services.

Importing Ansys HPC Platform Services Design Points Jobs into a Work-
bench Project
If you have evaluated design points in an Ansys HPC Platform Services project, you can import any
design points of interest into the Workbench project for further analysis or review:

1. On the Project Schematic, open the Parameter Set bar into which to import design points.

2. In the Table pane, right-click and select Import from HPC Platform Services.

Note:

This option is also available on the context menu for the Outline pane if you
right-click a node that supports importing design points from Ansys HPC Platform
Services.

The Import from HPC Platform Services window opens.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 385
Working with Ansys HPC Platform Services

To select the design points to import, you can specify design point IDs, enter a query string,
or enable filters. When you place the mouse cursor over the description for the field in which
you enter IDs or a query string, the tooltip displays usage examples.

By default, the maximum number of design points returned from a query or from enabled filters
is 1000. However, before querying or filtering, you can change the value for Max Results. This
field appears in the upper right corner, below the Search button.

3. Select the design points to import using one of these methods:

• Specify design points IDs, separating them with commas, and click Search.

• Enter or select a previously entered query string and click Search.

• Click the buttons for filters to switch between enabling and disabling them. Choices are
for the evaluated, timeout, and failed status filters and the star filter.

The heading for the Design Points pane displays the total number of design points selected
in parentheses. The table displays these design points. Below the table, the buttons on the left
clear the table of results and clear the Status pane of processing information. On the right, the
Import button imports the selected design points into the Parameter Set bar.

4. Once the table displays the design points that you want to import, click Import.

The window closes and a progress bar appears.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
386 of ANSYS, Inc. and its subsidiaries and affiliates.
Resetting the Ansys HPC Platform Services Project ID

If the Ansys HPC Platform Services project and Workbench project have differences beyond just design
points, a dialog box indicates that imported design points will be set out-of-date and asks if you want
to continue.

The design points that are imported into the Workbench project from Ansys HPC Platform Services are
not linked to the design points in Ansys HPC Platform Services. You can perform standard operations
on an imported design point, such as setting it as the current design point.

Evaluating Design Points or Project Updates in Multiple Process Steps


You can set up a Workbench project to have Ansys HPC Platform Services evaluate design points or
project updates in multiple process steps (tasks) on multiple machines. For example, you might be using
standalone SpaceClaim, third-party geometry and CAE tools plus an Ansys solver tool, and a Python
postprocessing tool.

When running simulations in a mixed environment:

1. In the Project Schematic, right-click the Parameter Set bar or the white space of the Project
Schematic and select Properties.

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

3. Select Jobs → Sync with HPC Platform Services to send the updated simulation workflow
definition to the HPC Platform Services project.

4. In Ansys HPC Platform Services, go to the project's Task Definitions tab.

In the task pane on the left, two tasks are now visible:

• Workbench_Geometry

• Workbench_Solution

5. Define each of these tasks.

For more details, see Defining a task in the Ansys HPC Platform Services Guide.

Resetting the Ansys HPC Platform Services Project ID


When submitting a Workbench project to Ansys HPC Platform Services, a project ID is created.

To reset the project ID, allowing you to create a new one, from the menu bar select Jobs → Reset HPC
Platform Services project ID.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 387
Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
388 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with Ansys optiSLang
The Ansys Workbench optiSLang Extension optimizes your product designs by combining the powerful
parametric modeling capabilities of Workbench with the Robust Design Optimization (RDO) methods
of optiSLang. The optiSLang toolbox includes modules for sensitivity analysis, optimization, and robustness
evaluation that you can easily drag and drop into a Workbench project to form an interactive process
chain.

Activating the Ansys Workbench optiSLang Extension


You can install optiSLang and the Ansys Workbench optiSLang Extension through the Ansys unified
installer or optiSLang Standalone installer.

When you first open Workbench, the extension will be active only if you have a valid optiSLang license.
You can manually activate/deactivate the extension:

1. From the menu bar, select Extensions → Manage Extensions.

2. To load the extension, select the check box to the left of optiSLang.

3. To have the extension load each time you open Workbench, right-click optiSLang and select Load
as Default 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. 389
Working with Ansys optiSLang

Migrating Workbench Projects from the SDK to ACT Extension


Earlier versions of the extension were written using an SDK, while the latest version has been written
using Ansys ACT. The following table demonstrates the differences between the two extension versions.

Function SDK ACT


Select files Save project files generated during design Save project files generated during design
point update to the optiSLang design point update to the optiSLang design
directory. directory with a separate Data Send
component system.

Data import Exchange of designs between Workbench Will be provided in a future version.
and export design table and optiSLang database file
(*.omdb).

optiSLang N/A Displays the general application settings in


configuration optiSLang.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
390 of ANSYS, Inc. and its subsidiaries and affiliates.
Migrating Workbench Projects from the SDK to ACT Extension

Function SDK ACT

License N/A Displays all available and used licenses in


management optiSLang.

optiSLang N/A Displays the settings of the currently open


project project in optiSLang.
settings

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

Function SDK ACT


Network Defines the scope for external access to Starts and stops the Network Discovery
access open projects. service to publish the currently opened
project in the local network.

Embed *.opd Option to archive or not archive the Option to archive or not archive the
files in *.opf optiSLang project directory (*.opd) in the optiSLang project directory (*.opd) in the
files optiSLang project file (*.opf). optiSLang project file (*.opf).

Derived Option to preserve dependent parameters Preserves dependent parameters from


parameters from parameter set as responses in parameter set as responses by default.
optiSLang.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
392 of ANSYS, Inc. and its subsidiaries and affiliates.
Migrating Workbench Projects from the SDK to ACT Extension

Function SDK ACT

Preserve and Options to preserve the design points and Options to preserve the design points and
retain data the generated design point data after an the generated design point data after an
update. update.

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

Function SDK ACT


Update with Option to submit a customized Python script Option to submit a customized Python script
journal for updating the table of design points. for updating the table of design points. Can
only be set directly on the system properties.

Clear Option to delete all result data before the Deletes all result data before the next
generated next update. update by default.
data

Set additional You can set additional environment variables Not required.
environment that are used in the next Workbench process
variables call.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
394 of ANSYS, Inc. and its subsidiaries and affiliates.
Migrating Workbench Projects from the SDK to ACT Extension

Function SDK ACT

Workbench • Input and output files located on the • Input and output files located on the Files
node in Ansys Workbench tab tab
optiSLang
• Cannot edit files • New edit function

• Environment tab available • Environment tab will be added in a


future version

• Designs per process option located


• Designs per process option located on
inAdditional options
the Execution Settings tab
• Use Ansys Workbench as local applica-
tion is no longer available

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

Function SDK ACT


• Use working copy of WB project is no
longer supported

To migrate a Workbench project:

1. Load the SDK project with the appropriate Workbench version.

2. Right-click a system and select Edit from the context menu.

3. Export the system settings (not results).

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
396 of ANSYS, Inc. and its subsidiaries and affiliates.
Migrating Workbench Projects from the SDK to ACT Extension

Additional steps are required for the following components:

Data Receive / Data Send

1. Open the Files tab.

2. Click the multi-action button to export the files.

Signal Processing

1. Switch to the Variables tab.

2. Right-click the pane and select Export variables 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. 397
Working with Ansys optiSLang

4. Repeat steps 2 and 3 for all other systems in the project.

5. Create a new project in the most recent version of Workbench.

6. Recreate the projects using the ACT extension components available in the Toolbox.

7. Import the corresponding settings exported in step 3.

Using the Ansys Workbench optiSLang Extension


The Ansys Workbench optiSLang Extension is an ACT extension that offers wizards for sensitivity studies,
multidisciplinary optimization, robustness and reliability analysis as well as Robust Design Optimization
supporting all kinds of Ansys design parameters.

The extension uses much of the same functionality as Workbench. To use the extension tools:

1. From the optiSLang and optiSLang Integrations sections of the Toolbox, add (p. 57) optiSLang
systems and components to the Project Schematic.

See System Connections (p. 402) for descriptions of optiSLang system connections.

2. Complete the optiSLang system wizards (p. 399), configure the optiSLang components (p. 399), and
work through (p. 69) any Workbench systems created.

3. Save the Workbench project (p. 275).

4. Update systems or the project (p. 248).

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

Algorithm Systems
Each algorithm is represented by a system consisting of parameters, criteria, algorithm settings, start
designs, nominal designs, and results. The first five components are combined into a wizard that is
launched when you add the system to the Project Schematic. Results can be opened with a post-pro-
cessor during or after calculations.

Optimization
The Optimization system prepares an optimization workflow using the parameter sets provided by
Workbench systems.

For details on the Optimization wizard, see Optimization Wizard. For an example tutorial, see Optimization
of a Damped Oscillator in Ansys Workbench in the optiSLang Tutorials.

Robustness
The Robustness system prepares a robustness or reliability analysis workflow using the parameter sets
provided by Workbench systems.

For details on the Robustness wizard, see Robustness Wizard. For example tutorials, see Robustness
Evaluation of a Damped Oscillator in Ansys Workbench and Reliability Analysis of a Damped Oscillator
in Ansys Workbench in the optiSLang Tutorials.

Sensitivity
The Sensitivity system prepares a sensitivity study workflow using the parameter sets provided by
Workbench systems.

For details on the Sensitivity wizard, see Sensitivity Wizard. For an example tutorial, see Sensitivity
Analysis of a Coupled Function in Ansys Workbench in the optiSLang Tutorials.

Integration Components
You can add the following optiSLang integration components to the Project Schematic.

Data Receive
Manages the data exchange of external files. Registered files can be received from different external
locations like file systems or versioning databases.

Each file entry is made available using a appropriate connection. Supported transfer types are:

• Geometry

• Engineering Data

• Mesh

• optiSLang

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

• Turbo Geometry

For more information, see Data Receive.

Data Send
Manages the data exchange of external files. Registered files can be sent to different external locations
like file systems or versioning databases.

In the standard view, the files from the Workbench design point directory are offered hierarchically on
the left, which can be transferred to the optiSLang design working directory. The selected files are listed
with their relative path on the right. This structure is retained during the file transfer.

If the files to be transferred are not known, or not available at the time the workflow is set up, a file
filter can be used. The definition of the filter is identical to that of the purge dialog.

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

For more information, see Data Send.

MOP Solver
Uses Metamodel of Optimal Prognosis surrogate models for CAE calculations.

Starting from a reduced number of simulations, a surrogate model of the original physical problem can
be used to perform various design configurations without computing any further analyses. These well-
distributed results are used to create the metamodels. The metamodel with highest Coefficient of Pro-
gnosis (CoP) is taken as the optimal by optiSLang. The MOP results are stored in an optiSLang monitoring
database *.omdb file or in an optiSLang *.bin file. The MOP Solver calls can be used to replace the
original solver process.

For more information, see MOP Solver.

Python
Provides Python scripting for automating tasks. For more information, see Python.

Signal Processing
Extracts scalar and non-scalar response values from Ansys result files and text files and provides the
non-scalar responses to optiSLang algorithm systems and the Ansys Workbench component in optiSLang
if the programs are connected locally. Signal processing in the extension requires access to the file
system so remote connections are not supported.

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

The extraction may reduce data, as only the extracted optiSLang raw value (*.orv) files are saved,
not the result file. The raw value files are saved automatically to the respective optiSLang design direct-
ories and are used for providing responses within the optiSLang systems. If you are defining scalar re-
sponses, they are added to the Ansys parameter set.

For more information, see ETK.

System Connections
To create a specific workflow and to exchange data between different systems connections, add the
optiSLang algorithmic systems and integration components to the Project Schematic using the instruc-
tions provided in Adding Systems to the Project Schematic (p. 57).

You can make connections between the following optiSLang systems and components.

MOP Solver to Optimization


Finds improved designs as a result of a metamodel-based sensitivity analysis. Data exchanged is the
information about parameters. You can establish multiple connections between the two systems. This
connection can be established for all optimization strategies except for ARSM which uses its own meta-
modeling approach internally.

Sensitivity to Sensitivity
Enhances an existing sampling by adding further samples. Data exchanged is the information about
parameters, criteria, and the already sampled designs.

Sensitivity to Optimization
Finds improved designs as a result of a sensitivity analysis. If an objective function is defined in the
Sensitivity system, the best design is exchanged as a start design for the optimization. Otherwise, a
connection is not established.

Optimization to Optimization
Checks if any further improved designs can be found in the existing best designs. Data exchanged is
the information about parameters, criteria, and the already sampled designs.

Optimization to Robustness
Analyzes the robustness of optimization results. The best design of the optimization is exchanged to
set the nominal design for the robustness analysis. You establish connections from an Optimization
system to multiple Robustness systems.

optiSLang Extension User Interface Reference


The following components are specific to the Ansys Workbench optiSLang Extension. For general
Workbench interface details, see Workbench Interface Reference (p. 455).

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
402 of ANSYS, Inc. and its subsidiaries and affiliates.
optiSLang Extension User Interface Reference

Menu Bar
File Menu

Menu Item Description


Load Archive Loads a project from an external data source.
From
Save Archive To Saves the current project to an external data source.

optiSLang Menu

Menu Item Description


optiSLang Settings Opens the application settings dialog.
License Opens the License Management dialog box and display an overview of all available
Management and used licenses.
Project Settings Opens the Project Settings dialog box.
optiSLang Help Opens and displays the optiSLang help.
About optiSLang Opens the About Ansys optiSLang dialog box containing various product details.
Export Designs Exports the table of design points to a JSON file and starts the optiSLang
postprocessing with it.
Export DX Data Exports the parameters, designs and optimization criteria of a Design Explorer
system to be selected in an optiSLang readable JSON file. This menu item is only
displayed if there is a Design Explorer system in the Project Schematic.
Remote Control Opens a dialog to register remote server connection data, allowing remote access
to the project from the Ansys Workbench node in optiSLang. Enable or disable the
connection by clicking Start or Stop.
Go To optiSLang Opens the optiSLang application where you can continue to work on the
project. Also available as a shortcut button.

Context Menu
Menu Item Description
Edit Opens a dialog to edit specific system or component settings.
Finalize If an algorithm component was stopped, it can be finalized to continue the calculation
of further systems.
Refresh Reloads the parametric data from Workbench.
Parameter
If parameters are added to or removed from the parameter set in Workbench,
select Refresh Parameter in all optiSLang systems before updating the project.

All new parameters are added to the system without changing the user-defined
properties of the existing ones.

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

Menu Item Description


Parameters removed in Workbench are also removed for the optiSLang system.

Note:

When you change the parameter in your model, optiSLang does not
adopt the new parametric as this would imply a reset and data loss of
an entire result. Therefore, you should perform the parameter refresh
on purpose.

Results Opens the postprocessing dialog for the system.


DoE Results Opens the statistics postprocessing of the Design of Experiment or sampling component
for this system.
Import DX Data Opens a selection dialog for a DX system and transfers the parameters, designs (as
start designs) and optimization criteria to the optiSLang system.
Export FMU Exports the metamodel to Functional Mock-up Interface.

Properties Pane
Property Description
Preserve Design Points After Preserves designs belonging to the currently updated system in the
optiSLang Run table of design points.
Retain Data for Each Preserved Retains generated design point files during the update in the Workbench
Design Point design point directory.
Use Simultaneous Execution Submits multiple design points in parallel to Remote Solve Manager
Mode (RSM). When selected, optiSLang submits the number of design
points entered in Number of Design Points sent to Parameter Set at
the same time. If this is not selected, the design points are
submitted to RSM sequentially.

For more details on submitting design points to RSM, see Updating


Design Points in Remote Solve Manager (p. 360).
Number of Design Points sent Submits the listed number of design points to RSM, either in parallel if
to Parameter Set Use Simultaneous Execution Mode is enabled, or sequentially if it is not.
The size is automatically adjusted if fewer designs need to be evaluated.
Set this number based on the number of free clients in your RSM setup.
Run Journal for Update Controls the project, system, or cell update using the selected Python
script or Workbench journal.

Situational Dialogs
The following dialogs can appear, depending on the project state.

Dialog Description
Interrupt/Abort (p. 251) Allows you to interrupt the calculation of a project.

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

Dialog Description
Recovering Allows you to continue a crashed session.
Projects (p. 283)
Reset Defines which data can be discarded when resetting the project or component.
Remove Working Confirms the decision when selecting Remove design directories before
Directory calculating.
Confirm Modifications Applies modifications to a component. This might cause a loss of calculated
data. Different scenarios are offered for resetting the component.

Project File Structure


optiSLang projects in Workbench use the following directory structure and files.

*.wbpj/*.wbpz—Workbench project file or archive

*_files—Workbench working directory

• dp0—The current design point (reference design)

– ETK—Signal Processing (p. 399) working directory

File/Folder Description
*.opd optiSLang working directory
*.opf optiSLang project file
*.orv optiSLang raw value file
Input file Input file for signal processing
Output Output file for signal processing
file

• user_files—User or program provided files

– optiSLang protocol file containing project session information (for example, calculations or errors)

• *.opf—optiSLang project file

• *.opd—optiSLang working directory

– Algorithm systems

→ *.omdb—optiSLang monitoring database file

→ Design directories—Created for every run started by optiSLang. The numbers of these directories
are equal to the numbers of the designs shown in the history plots. Stores and processes the
modified input files and the result files.

File/Folder Description
Input file Input file for design

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

File/Folder Description
Output file Output file for design
Solver Solver output files for design
Output
*_files Workbench working directory

– *.omdb—optiSLang monitoring database file

*.optislang—A special folder that optiSLang creates when the Workbench project information is
read for the first time. It contains a JSON file with all relevant data, such as parameters, responses, re-
gistered files and a hash value. Reloading the project information is only necessary if the hash value of
the project has changed.

System Environment
The Ansys Workbench optiSLang Extension uses the system environment and registry to find the com-
patible optiSLang application in the following order:

1. Environment variable OPTISLANG_HOMEXXXX

where XXXX is the Workbench version number, with leading zeros if applicable. For example
OPTISLANG_HOME0810 or OPTISLANG_HOME2110.

2. OPTISLANG_HOMEXXXX entry in

• Windows: %APPDATA%\Dynardo\optiSLangWBExtension.ini

• Linux: %HOME%/.config/Dynardo/optiSLangWBExtension.ini

3. Under AWP_ROOT of the currently running Workbench version.

4. Registry (Windows only)

• HKEY_CURRENT_USER\SOFTWARE\Dynardo\ANSYS optiSLang entry of the Windows registry if


optiSLang was installed for the local user

• HKEY_LOCAL_MACHINE\SOFTWARE\Dynardo\ANSYS optiSLang entry of the Windows registry if


optiSLang was installed for all users

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
406 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with Workbench and Ansys Minerva
Ansys Minerva is a simulation process and data management (SPDM) software system that enables you
to work with simulation data in a repository. Within Workbench, you can create a connection to an
Ansys Minerva site so that you can transfer projects to and from Ansys Minerva repositories.

You can use Ansys Minerva to:

• Archive completed projects or store works-in-progress in a central repository

• Share your projects and collaborate on those of others

• Retrieve your own projects or those shared by other users

• Change the permissions of projects or place them under version control

• Search projects based on names, dates, simulation type, or other criteria

• Create reports

For more details, see the Ansys Minerva User's Guide.

Related topics:
Creating a Connection to an Ansys Minerva Site
Displaying the Ansys Minerva Toolbar
Launching Ansys Minerva with a Web Browser
Working with Workbench Projects Saved in Ansys Minerva

Creating a Connection to an Ansys Minerva Site


To be able to save a Workbench project to or retrieve a project from Ansys Minerva (directly from
Workbench), you must create a connection between your local Workbench installation and an Ansys
Minerva site.

A connection contains information about the server hosting Ansys Minerva, the database to use, and
the authentication type.

To create a connection in Workbench:

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

2. From the list, select Ansys Minerva

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 407
Working with Workbench and Ansys Minerva

3. Specify a Authentication Type for the connection.

Note:

Select the method that matches what is configured for the Ansys Minerva server you
are connecting to.

• Basic—Uses a username and password to authenticate using the internal mechanism within
Ansys Minerva.

• Browser—Uses the browser to authenticate. If you are logged into Ansys Minerva in the browser,
those credentials are used.

• Windows—Uses Active Directory to pass the credentials of the user currently logged into the
Ansys Minerva server.

4. Enter the Server URL address of the Ansys Minerva server.

5. Enter the Ansys Minerva Database to access.

6. Click OK.

Displaying the Ansys Minerva Toolbar


The Ansys Minerva functions available from the Workbench File menu are also available in the Ansys
Minerva toolbar.

To display the toolbar, select View → Toolbars → Ansys Minerva Toolbar.

Launching Ansys Minerva with a Web Browser


To access Ansys Minerva directly, open the web client in your default browser by doing one of the fol-
lowing:

• Select File → Ansys Minerva → Launch Minerva Web Client.

• Click on the Ansys Minerva toolbar.

Working with Workbench Projects Saved in Ansys Minerva


When working with an Ansys Minerva repository, you must understand the relationship between your
local working version of the project and the copy stored in the repository. Even if a project has been
stored to or opened from a repository, Workbench always operates directly on the local working copy
of the project.

Workbench is aware of the relationship between the local project and the repository copy, and helps
you manage your project and maintain consistency. You can save the local copy of a project to the re-

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
408 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with Workbench Projects Saved in Ansys Minerva

pository at any point. If you open a local project, and the copy in the repository is more recent, you
have the option of downloading and updating to the repository version.

When you save a Workbench project to an Ansys Minerva repository, Ansys Minerva always stores it as
a virtual project archive (with the *.wbpz extension) so that you can act on a single object, rather than
on a set of objects.

Related topics:
Saving the Current Workbench Project to an Ansys Minerva Repository
Saving the Current Workbench Project to a New Location in the Repository
Opening a Project from an Ansys Minerva Repository
Claiming a Project
Unclaiming a Project

Saving the Current Workbench Project to an Ansys Minerva Repository


You can save your current Workbench project to an Ansys Minerva repository for archive storage, or
to share with other users.

Note:

The first time the project is saved, all of the files are sent to Ansys Minerva. In subsequent
saves, only the items in the project that have changed are sent.

To save the current project to an Ansys Minerva repository:

1. Save any project changes locally.

2. From the menu bar, select File → Ansys Minerva → Claim or on the Ansys Minerva toolbar, click
.

3. From the menu bar, select File → Ansys Minerva → Save or on the Ansys Minerva toolbar, click
.

4. If you have not authenticated against an Ansys Minerva site, the Connect dialog box appears.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 409
Working with Workbench and Ansys Minerva

a. Enter your Username and Password.

b. Click OK.

5. If this is the first time you have saved this project to Ansys Minerva:

a. Browse to the location in the repository to save the files.

• To search for the location, enter the text in the search field. You can include wildcards in
the search terms.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
410 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with Workbench Projects Saved in Ansys Minerva

• To clear the search, right-click the right pane and select Clear Search from the context
menu.

You can also clear the search by clicking on a different location in the tree in the left pane.

• To add a new folder, right-click the right pane and select New Folder from the context
menu.

Note:

This location will be automatically selected in subsequent saves. To save a copy


of the project to a new location, complete a save to operation (p. 411).

b. Click OK.

Saving the Current Workbench Project to a New Location in the Repository


Once you have saved a project to Ansys Minerva, Workbench stores the path to the repository location
and subsequent saves are made to the same location. To switch to a new storage area, you must
complete a save to operation.

To save the project to a new location:

1. Save any project changes locally.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 411
Working with Workbench and Ansys Minerva

2. From the menu bar, select File → Ansys Minerva → Claim or on the Ansys Minerva toolbar, click
.

3. From the menu bar, select File → Ansys Minerva → Save To or on the Ansys Minerva toolbar,
click .

4. If you have not authenticated against an Ansys Minerva site, the Connect dialog box appears.

a. Enter your Username and Password.

b. Click OK.

5. Browse to the location in the repository to save the files.

• To search for the location, enter the text in the search field. You can include wildcards in the
search terms.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
412 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with Workbench Projects Saved in Ansys Minerva

• To clear the search, right-click the right pane and select Clear Search from the context menu.

You can also clear the search by clicking on a different location in the tree in the left pane.

• To add a new folder, right-click the right pane and select New Folder from the context menu.

6. Click OK.

Opening a Project from an Ansys Minerva Repository


When you open a project from an Ansys Minerva repository, the archive file is downloaded, extracted,
and opened in Workbench.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 413
Working with Workbench and Ansys Minerva

The files are saved automatically to the location you specify in your Workbench user preferences, on
the Project Management page. See Project Management in the Workbench User’s Guide for more in-
formation.

To open a project from an Ansys Minerva repository:

1. From the menu bar, select File → Ansys Minerva → Open or from the Ansys Minerva toolbar,
click .

2. If you have not authenticated against an Ansys Minerva site, the Connect dialog box appears.

a. Enter your Username and Password.

b. Click OK.

3. Browse to the project file location in the repository.

• To search for the location, enter the text in the search field. You can include wildcards in the
search terms.

• To clear the search, right-click the right pane and select Clear Search from the context menu.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
414 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with Workbench Projects Saved in Ansys Minerva

You can also clear the search by clicking on a different location in the tree in the left pane.

4. Select the project file and click OK.

The archive file is downloaded and opened in Workbench.

Claiming a Project
When you have a project opened from the repository that is under version control, you can claim it.
This gives you exclusive control over the project and prevents other users from making any modific-
ations to it while you are working with it.

To claim a project:

1. Open the project from the repository (p. 413).

2. From the menu bar, select File → Ansys Minerva → Claim or on the Ansys Minerva toolbar, click
.

The project is claimed. A flag appears beside the project name in Ansys Minerva.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 415
Working with Workbench and Ansys Minerva

Unclaiming a Project
When you are finished editing a project, you release it back to Ansys Minerva by unclaiming it.

To unclaim a project:

1. Open the project from the repository (p. 413).

2. From the menu bar, select File → Ansys Minerva → Unclaim or from the Ansys Minerva toolbar,
click .

The project is released. In Ansys Minerva, the claimed flag is removed from the project name.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
416 of ANSYS, Inc. and its subsidiaries and affiliates.
Troubleshooting Workbench
The following topics list issues and error messages that you may encounter while running Workbench.

These topics do not include troubleshooting for data-integrated applications. See the help for the spe-
cific application for troubleshooting information.

For additional troubleshooting information on native applications, see the following:

• Troubleshooting in the DesignXplorer User's Guide

• DesignModeler Frequently Asked Questions in the Ansys DesignModeler User's Guide

• Troubleshooting in the optiSLang User's Guide

Related topics:
General Workbench Issues
Product-Related Issues
Startup or Graphics Issues
Error Messages
Known Issues and Limitations

General Workbench Issues


This topic lists issues that you may encounter in various areas of Workbench.

Error Messages Appear During Workbench Setup


During setup, if you encounter any errors containing 0x8000FFFF, you must install the required in-
stallation prerequisites.

1. To open the Product & CAD Configuration Manager, select Start > Ansys 2024 R1 > Product &
CAD Configuration 2024 R1.

2. Click Install Required Prerequisites.

CAD System Plug-In Menus Do Not Appear for NX or Creo Parametric


On Windows platforms, Workbench appends its information to an existing customization file. If a cus-
tomization file does not exist, a new one is created. For NX, Workbench looks for the custom_dirs.dat
file in the directory specified in the UGII_CUSTOM_DIRECTORY_FILE environment variable. For Creo
Parametric, Workbench looks for the config.pro file in the %HOMEDRIVE%%HOMEPATH% directory.

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

When the Creo Parametric Geometry Interface is set up, Workbench also appends its information to the
config.pro file located in the Creo Parametric installation path, under the \text directory (for ex-
ample, Proewildfire2\text\config.pro).

If Workbench encounters a read-only file, it cannot write the necessary information to the file. To display
the Ansys menu in NX or Creo Parametric, you must change the permissions on the file and manually
add the appropriate Workbench-specific information.

Script Errors When Running Workbench


If you encounter script errors such as Error: Unable to create object microsoft.XMLDOM,
you may need to install the latest version of Microsoft Core XML Service (MSXML).

See the MSXML Download Page for more information on downloading and installing MSXML.

Charts Do Not Appear


If you do not see the appropriate charts created after a design point run or other updates (such as re-
sponse surface updates), from the menu bar select View → Reset Workspace.

Applications Do Not Start After Crash


On Linux machines, if Workbench applications do not launch after an abnormal exit such as a crash,
run the following utility:
$INSTALL/v241/aisol/wbcleanup

Wobbly Windows Desktop Effect Causes Crashes


The wobbly windows desktop effect on Linux machines may cause Workbench or its applications to
crash. This effect is on by default on some Linux platforms. Make sure the effect is turned off.

Linux Threading Limit


By default, many Linux systems limit the total number of threads each user can run at once, to avoid
multiple processes overloading the system. If you are running many Ansys jobs concurrently as the
same user (for example, submitting them through Remote Solve Manager), you may hit this limit, pro-
ducing errors such as Thread creation failed.

To view the current thread limit, run the following command:

• ulimit -u (bash)

• limit maxproc (csh)

To increase the thread limit, run the following command:

• ulimit -u [limit] (bash)

• limit maxproc [limit] (csh)

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

Where [limit] is a numerical value (for example, 4096).

To view the administrator-imposed hard limit, run the following command:

• ulimit -H -u (bash)

• limit -H maxproc (csh)

You cannot increase the limit amount beyond this hard limit value. Contact your system administrator
to increase the hard limit.

Communication Errors with Hyper-V Virtual Ethernet Adapter


Running Workbench projects containing System Coupling components through a virtual machine or
VPN connection can cause various errors, for example:
Updated failed for the Solution component in System Coupling. The coupling service failed to start.

This is caused by a Hyper-V virtual ethernet adapter preventing the Message Passing Interface (MPI) (a
method for managing multiple processes) from working correctly.

To solve this issue:

1. Open Control Panel.

2. Click Network and Sharing Center.

3. Click Change adapter settings.

4. Find the adapter that has Hyper-V Virtual Ethernet Adapter in the description.

5. Right-click the adapter and select Disable from the context menu.

6. Repeat step 5 for all other Hyper-V adapters.

Design Point Update Subtask Error When Using UGE Scheduler


When submitting design point updates to Remote Solve Manager, the design points are allocated to
one or more tasks and these tasks are allocated to one or more RSM jobs. This method of job submission
can create an error similar to the following when using an UGE scheduler queue:

executing task of job 3119 failed: execution daemon on host


"testhost.domain.com" didn't accept task

To solve this issue, open the sge_pe file on the cluster and change the daemon_forks_slaves
parameter to FALSE.

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

Using 4K Displays with Workbench


Currently, Workbench does not support 4K displays. You may see one or more of the following issues
if you use Workbench on a 4K display:

• Initially launching Workbench displays a tiny window and text is cut off.

• Titles are cut off.

• You must maximize the Workbench window twice before it is set to full screen.

• Various parts of the user interface are scaled incorrectly, including tab titles, drop-down menu text,
toolbars, and the ACT start page.

To improve these issues, complete the following procedure:

1. On the Windows toolbar, select Start > Ansys 2024 R1

2. Right-click the Workbench 2024 R1 icon and select More → Open file location from the context
menu.

3. In the Ansys 2024 R1 folder, right-click the Workbench 2024 R1 icon and select Properties from
the context menu.

4. Switch to the Compatibility tab.

5. Under Settings, click Change high DPI settings.

6. Select the Override high DPI scaling behavior. Scaling performed by: check box.

7. Select System from the drop-down menu below the check box.

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

8. To save the change and close the dialog box, click OK.

System Coupling Crashes Workbench in Remote Session


If you are loading the System Coupling component system user interface during a remote Workbench
session and Workbench crashes, restart the machine.

HDF5 File Locking


The HDF5 version used in 2024 R1 will result in failure when the underlying file system does not support
file locking, or where locks have been disabled. To disable all file locking operations, create an environ-
ment variable named HDF5_USE_FILE_LOCKING and set the value to the five-character string FALSE.

Product-Related Issues
This topic lists issues that may occur in products that integrate with Workbench.

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

Installing the Multilingual User Interface Pack of Microsoft Office for your
Language
If you run the 2007 or 2010 English version of Excel and the locale for the current user is configured
for a language other than English, Excel tries to locate the language pack for the configured language.
If the language pack is not found, then the error is reported and the automation of Excel, as used by
the Excel as a calculator feature, cannot be performed. To solve this issue, you must install the Multilingual
User Interface Pack of Microsoft Office for your language. As an alternative, you can also configure the
locale for the current user to English.

This bug is documented by Microsoft. For more information, see http://support.microsoft.com/kb/320369.

Design point Failure when Updating Project with Multiple Excel Systems
If you have Office Excel 365, Office Excel 2013, or Office Excel 2016 installed on your machine and your
Workbench project contains multiple Excel systems and the Excel process window is hidden, updating
the project may cause design points to fail and the following exception message to display:

We found a problem with this formula. We couldn't find a range reference


or a defined name.

Workaround: Before running any update operations, open the Excel process window by right-clicking
and selecting Open File in Excel.

This issue is documented by Microsoft. For more information, see https://support.microsoft.com/en-us/


kb/3083825.

Workbench and optiSLang Crash Dialogs


When you start a Workbench project that contains optiSLang components, you may see some of the
following dialogs depending on the situation.

Workbench Crashed and optiSLang was Saving the Project

Workbench encountered a problem and crashed but optiSLang was able to save the *.opf project
file. In this case, you can recover the project. To see additional information before recovering, click
Show Details. All files that are modified and will be deleted are displayed. We recommend manually
saving a copy of the project files before recovering the project.

To recover the project, click Yes in the dialog.

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

Workbench Crashed and optiSLang Crashed without Saving the Project

Both Workbench and optiSLang crashed and the project could not be saved. To continue with the
project, return it to its last saved state. To see additional information before restoring the saved state,
click Show Details. All files that are modified and will be deleted are displayed. We recommend
manually saving a copy of the project files before restoring the saved state.

1. To return the project to its last saved state, click Yes in the dialog.

2. Select which project save version to use.

Note:

We strongly recommend selecting the automatic save point.

optiSLang Crashed

optiSLang encountered a problem and crashed, and the optiSLangAddin.exe file exited. You can
now restart the Workbench extension and continue the project.

1. To restart the extension, click Yes in the dialog.

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

2. Select which project save version to use.

Note:

We strongly recommend selecting the automatic save point.

Project Files have been Relocated

Files referenced by the project have been moved and cannot be found. You can automatically relocate
these files by selecting the option in the dialog.

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

Failed to Start optiSLang Error when using optiSLang Extension in Workbench


When using the optiSLang extension inside Workbench, the following error can occur:

'NoneType' object has no attribute 'password' & Exception: Failed to


start optiSLang, no executable

To fix this issue, you must edit the optiSLangWBExtension.ini file. You can do this by either using
the Workbench user interface or editing the file directly in a text editor.

Workbench User Interface

1. Set the value of the DYNARDO_VERBOSE_LEVEL environment variable to 1.

2. Start Workbench.

3. If the optiSLang extension is not loaded, activate it (p. 389).

4. From the menu bar, select optiSLang → Extension Settings.

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

The optiSLangWBExtension.ini file opens in an editor.

5. In the file, add one or more paths to optiSLang installations.

The structure of each entry is OPTISLANG_HOMEXXXX=/path/to/optislang/ where XXXX


contains the installation path version number. For example, OPTISLANG_HOME2210 points to
the installation path of optiSLang 2022 R1.

Open in Text Editor

1. Navigate to the location of the optiSLangWBExtension.ini file.

• Windows: %APPDATA%\Dynardo

• Linux: $HOME/.config/Dynardo

2. Open the file in a text editor.

3. In the file, add one or more paths to optiSLang installations.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
426 of ANSYS, Inc. and its subsidiaries and affiliates.
Startup or Graphics Issues

The structure of each entry is OPTISLANG_HOMEXXXX=/path/to/optislang/ where XXXX


contains the installation path version number. For example, OPTISLANG_HOME2210 points to
the installation path of optiSLang 2022 R1.

Error When Loading Files in TurboGrid Opened Through Workbench


After opening TurboGrid using a TurboGrid component system in Workbench, loading an Init file by
selecting File → Load TurboGrid Init File, and saving the project, the following error message is dis-
played:

Unable to load DLL 'cclapilt.dll': The specified module could not be


found. (Exception from HRESULT: 0x8007007E)

Workaround: Install MS VC++ Redistributable for Visual Studio 2012 Update 4.

Startup or Graphics Issues


This topic lists issues that you may encounter with starting Workbench or Workbench graphics.

To minimize graphics problems, always verify that you are running the latest graphics drivers provided
by your computer's hardware manufacturer. If you are not, you may see the following message:
***An error occurred while setting up the graphics window. Please ensure that you have the latest drivers
from your graphics card manufacturer. If the error persists, you may need to decrease the graphics
acceleration. For more information, please see the Troubleshooting section in the Ansys Workbench help.

Linux
If you are running Workbench on Linux and experience problems at startup or with the user interface
or graphics displaying correctly, and you are running in accelerated graphics mode, you may need to
relaunch Workbench using the -oglmesa flag to activate software rendering:
runwb2 -oglmesa

If Workbench detects that graphics problems are causing crashes, it automatically switches to software
rendering. Workbench also uses software rending mode by default when running on a remote display,
or on a local display if the hardware does not appear to be accelerated.

To revert to accelerated graphics mode, launch Workbench using the -oglhw flag:
runwb2 -oglhw

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

If you are running under Exceed3D, try the following settings if you are having graphics problems:

• Turn off the graphics (hardware) acceleration option in Exceed3D options.

• If graphics acceleration is on, turn on the GLX 1.3 option.

Any version of Exceed that does not have the GLX 1.3 option is unlikely to function correctly with
graphics acceleration.

Windows
If you experience graphics issues on Windows systems, you can find the details of your graphics card
and the driver that is currently installed by selecting Start → Run and typing the following into the
Open field:
dxdiag

Select the Display tab and review your graphics card information. You can then contact the vendor or
visit the vendor's website for details of the latest graphics drivers available for your specific graphics
card.

You may also have to adjust the hardware acceleration. To adjust the hardware acceleration, Open
Control Panel and select Display → Settings → Advanced → Troubleshoot or your operating system's
equivalent. The hardware acceleration slider should then be visible. You can also select Display →
Settings → Troubleshoot and use the troubleshooting tool to guide you to the Hardware Acceleration
panel. Try turning hardware acceleration off by dragging the slider to None. Try the software again; if
the graphics problems are resolved, then gradually increase Hardware Acceleration as far as you can
before the software fails again.

Error Messages
This topic lists error messages that you may encounter in Workbench.

Unable to connect to Solver Manager


Another application might be using the Solver Manager port (10002 by default). Try changing the port
number by editing the Ansys.SolverManager.exe.config file located in the installation directory
at \AISOL\Bin\<platform>.

If you are having difficulty launching other applications/editors, it is also possible that the Windows
hosts file has been corrupted. Make sure that localhost is specified in the Windows <os
drive>:\Windows\system32\drivers\etc\hosts file.

Warning at File: myxml, line 1, col 40, Encoding (utf-16, from XMLDecl or
manually set) contradicts the auto-sensed encoding, ignoring it
The message is sometimes displayed in the Remote Solve Manager (RSM) log; you can ignore it.

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

System.IO.IOException: Too many open files


Many Linux distributions set a default maximum for the number of files a process can have open and
this can be exceeded when solving some cases. You must increase the maximum number of open files
allowed by editing limits.conf, which on most Linux distributions is found in /etc/security/lim-
its.conf.

For example, adding the lines


# ANSYS file handle limits modification
* soft nofile 2048
* hard nofile 2048

to limits.conf sets the maximum number of open files to 2048 (the default on most Linux distribu-
tions is 1024). Increase the maximum number of open files allowed by powers of 2, trying 2048, 4096,
8192.

Further information can be found in the manual page for limits.conf, which can be accessed using
the command man limits.conf on any Linux machine with the man command installed.

You can check the current limit by using the command ulimit -a in a bash shell session or limit
in a tcsh shell session. In the output, the maximum number of open files is displayed under open files
or descriptors, respectively.

Known Issues and Limitations


The following are known issues at the time of release, as well as system and software limitations:

• KDE is not supported on SuSE Linux Enterprise Server & Desktop 12.

• When a job is submitted that requires the MAPDL solver, and no MAPDL license is available, the job
may appear to be in the 'starting' state in the job monitor for up to 20 minutes before the issue is
reported. Additionally, if you check your system processes (with ps on Linux or Task Manager on
Windows), you may see some solver processes still running after 20 minutes. These may run for up
to 80 minutes, but are small and do not consume significant resources.

• When running or updating a Workbench project on a Linux machine that generates many files, such
as a large number of Design Points running concurrently, the solver can fail with the following excep-
tion:

System.IO.IOException: Too many open files

To prevent this failure, increase the maximum number of files able to be opened at one time by
running the ulimit command ulimit -n [limit] where limit is either a numerical value (for
example, 1000000) or, “unlimited”.

• When running Workbench on a Linux machine, it crashes when you select Extensions → ACT Start
Page from the menu bar or click ACT Start Page on the Project tab toolbar. This crash is caused by
the libtotem-mozplugin.x86_64 version 2.28.6-4.el6 dll package, used for video
playback in browsers. To avoid the crash, uninstall the package.

• The Excel feature in Workbench requires Microsoft Office Excel 2013 or 2016.

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

• The Excel feature is only available on Windows systems.

• In a project with retained design points, switching to a different up-to-date design point using the
Set as Current menu option automatically updates the Excel system, which could be time-consuming
if the spreadsheet contains macros or extensive calculations.

• Files written by Ansys products cannot be synchronized with Microsoft's OneDrive file hosting service.

• Workbench products do not support running a network user installation as local root administrator.

• On Linux, transferring DesignModeler geometry from the geometry cell to a downstream HFSS Design
system fails if the upstream geometry is not open in the DesignModeler editor. In this case an OnRe-
freshTransferData failed! error message is displayed. Open the geometry in DesignModeler
before transferring it so that the transfer succeeds.

• When Material Designer is linked to Engineering Data, modifying a material name in Material Designer
does not change the corresponding material in Engineering Data but rather creates a new material
with the new name. The prior material should be deleted from Engineering Data before updating
downstream components.

• Parameterizing a non-integer, non-zero number in a Forte project when your system is set to a
European number format (the decimal separator uses a comma) causes the parameter value to be
displayed as zero in Workbench. Ensure your system is set to a number format that uses a period as
the decimal separator.

• Negative dimension values can invert the direction vector of SpaceClaim operations that they are
associated with; 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 dimension for a SpaceClaim geometry,
negative dimension values may result in incorrect or unexpected geometric changes.

• Workbench can stop working when updating multiple design points in one task through Remote
Solve Manager installed on a Linux cluster. The following error message is displayed in the Remote
Solve Manager Job Monitoring application:

ClusterJobs Command Exit Code: 134

Assertion at class.c:2876, condition 'iid <= 65535' not met

To work around this issue, reduce the number of design points that are updated in each task.

• When using Workbench on Linux systems, you cannot use a Mechanical APDL system to launch
MAPDL when the graphics mode is set to 3D. You must use the X11 graphics mode.

• Because Workbench and Ansys AEDT use two different unit systems, upstream parameter values are
transferred to AEDT with SI unit values. There are no computations errors, but when you graphically
display the design in AEDT, you cannot see the units as specified in Workbench. They are displayed
as unitless values in SI.

• If you select the Physics Definition check box in the Geometry cell properties after importing a
Discovery file, then click Update Project or Refresh Project, the following error can occur:

Data entity not found: /Schematic/Component:Setup

To work around this issue, refresh each component one at a time.

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

• Older Sherlock projects resumed in 2024 R1 require you to rescope Mechanical loads if you re-export
Sherlock FEA or reinforcement data. After refreshing the new data into Mechanical, rescope the
boundary conditions that use the Geometry Selection scoping method. This step must occur before
the analysis can be updated again.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 431
Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
432 of ANSYS, Inc. and its subsidiaries and affiliates.
Workbench User Preferences
User preferences are set in the Options dialog box.

The preferences you set here are local settings, affecting only you. Some changes made in the Options
dialog take place immediately, while others take place after you restart Workbench.

Use the Restore Defaults button to reset the settings visible on the current page to their default values;
settings on other pages remain unchanged.

Note:

An IT manager can a place a site-wide configuration file into the installation directory of each
client machine to ensure that the Workbench software preferences are configured as the
company requires. To force a preference to be set to a particular value at startup, edit
\Program Files\ANSYS Inc\24.1\Framework\Site\SiteStartup.wbjn.

You can set user preferences in the following categories:


Project Management
Appearance
Regional and Language Options
Graphics Interaction
Journals and Logs
Project Reporting
Solution Process
Extensions
Mechanical APDL
CFX
Design Exploration
Distributed Compute Services
HPC Platform Services
External Data
Fluent
Mechanical
Meshing
Engineering Data
Ansys Minerva
Microsoft Office Excel

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

TurboSystem
Geometry Import
Material Designer

Project Management
From Tools → Options → Project Management, you can specify the following.

Preference Description
Default Folder for Sets the file directory that is selected by default when saving or opening
Permanent Files a project.

Note:

Ansys recommends seting this preference to a local drive


rather than a network drive due to performance reasons.

When you select a different location for a project by browsing to it in


a dialog, Workbench remembers the folder location for subsequent
operations for the rest of the session; however, upon starting a new
session, the default returns to the location specified here.

To have Workbench determine the default location, select the Automat-


ically Determined by Workbench check box. To set the default location
yourself, clear the Automatically Determined by Workbench check
box and browse to the required folder.
Folder for Temporary Files Sets the folder where temporary files are written. The directory specified
here holds project files that are generated before the project is saved.
Once a project is saved, files are written to the project directory (p. 284).

Note:

Ansys recommends seting this preference to a local drive


rather than a network drive due to performance reasons.

.wbpz Compression Level Sets the file compression level for archiving projects (p. 276) to the .wbpz
format. The default is 3. Possible values are 0 through 9, with 0 as no
compression and 9 as maximum compression.
Share a single license Specifies which licensing method to use. You can:
between applications
when possible • Share a single license between applications (selected by default)

• Use a separate license for each application (clear the check box)

If you change this setting, you must restart Workbench for this setting
to take effect.

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

Preference Description
For more details on these licensing methods, see Ansys Workbench
Licensing Methods in the Ansys, Inc. Licensing Guide.

Appearance
From Tools → Options → Appearance, you can specify the following.

Preference Description
Graphics Style
Controls the graphics style of the Ansys Workbench,DesignModeler, Meshing, and Mechanical applications.
Workbench Theme Sets the apperance of multiple Workbench user interface components. Select
from the following options:

• Classic Theme (default)

• Light Theme

Background Style Sets a solid graphic background or a gradient background that varies from
top to bottom, left to right, or diagonally. The default is the top to bottom
gradient.
Background Color Sets a graphic background color from the built-in color palette. The default
color is blue.
Background Color2 Sets a second graphic background color from the built-in color palette. The
second color is used for gradient background displays. For example, if you
want a top-bottom gradient that starts out white and ends up black, Back-
ground Color should be set to white and Background Color2 should be
set to black. The default color is white.
Text Color Sets the color of all text from the built-in color palette. The default color is
black.
Edge Colors Sets the edge colors from the built-in color palette.
Meshed Sets the color of all meshed edges from the built-in color palette. The default
color is black.
Display
Controls how Workbench displays information.
Number of Significant Sets the number of digits that appear for numbers in Ansys simulation
Digits environments. The default is 5 and possible values are 3 through 10.

This setting affects only the numbers that are displayed. It does not
imply any numerical round-off of internal calculations.

When a user-entered number has a decimal halfway between two


integers, the number is rounded to the nearest even integer. For
example, a value of 20.5 is rounded down to 20, while a value of 21.5
is rounded up to 22.

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

Preference Description
Number of Files in Sets the number of files that appear in the Recently Used Files list for both
Recently Used Files List the File menu and the context menus. The default is 4 and the maximum
number of files that you can display is 20.

If the number specified here exceeds the number of recently used files
that are available, the list displays the available number. This setting is
applied to the current Workbench session.
Beta Options When selected, beta features are displayed with the word beta in parentheses.
This check box is cleared by default.

Beta features remain untested in this release and therefore are neither
documented nor supported and may result in unpredictable behavior.

The beta option on Linux for Mechanical Explicit Dynamics is not passed
to the solver and as such has no effect for solver related beta
functionality.
Unsupported Features When selected, displays deprecated features, with the word unsupported in
parentheses, in the Toolbox. This check box is cleared by default.

While unsupported features may still be used in older projects, we


recommend updating projects to currently supported features. Because
these features are unsupported, they may not function correctly in
newer versions of the product.
Text on Toolbars When selected, displays text labels on toolbars. This check box is selected
by default.

This option applies to the Ansys Workbench interface, the Mechanical


application, the Meshing application, and DesignModeler only.
Connections are Bundled When selected, displays connections between systems as a single link. The
at Startup label indicates all bundled connections. For example, linked systems that
shared Engineering Data, Geometry, and Model cells display a single link
with the notation 2:4, indicating that cells two (Engineering Data) through
four (Model) are connected. This check box is cleared by default.

This setting defines the initial default for all projects and can be
overridden within each project by selecting View → Show Connections
Bundled, or by selecting this option from the context menu on the
Project Schematic. Use of this option affects only newly created
projects.
System Coordinates are When selected, displays the system label letters and numbers. This check
Shown at Startup box is selected by default.

This setting defines the initial default for all projects and can be
overridden within each project by selecting View → Show System
Coordinates, or by selecting this option from the context menu on the
Project Schematic.
Quick Help Icons in System When selected, the quick help icon in cells where quick help is available.
Cells The icon appears as a small blue triangle in the lower right corner of the
cell. This check box is selected by default.

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

Preference Description
Word-wrap Text in Tables When selected, allows text in tables to wrap within the cells. This check box
is selected by default.

Regional and Language Options


From Tools → Options → Regional and Language Options, you can specify the language used for
Workbench text and messages.

You can choose to use English, German, French, or Japanese, if localized files are available. Workbench
records the language selected at installation and specified from this option in the languageset-
tings.txt file. You can also manually edit the languagesettings.txt file to specify the language.
You must exit Workbench and start a new session for changes to the language option to take effect.

Workbench looks for the languagesettings.txt file in the following locations, in order:

1. %appdata%\Ansys\v241 on Windows or $HOME/.ansys/v241 on Linux

2. <install_dir>\Ansys Inc\v241\commonfiles\Language (Windows) or <in-


stall_dir>/ansys_inc/v241/commonfiles/language (Linux)

Be aware that not all external applications may be translated; therefore, you may see some text and
messages in English even if you have specified a different language.

Graphics Interaction
From Tools → Options → Graphics Interaction, you can specify the following.

Preference Description
Mouse Wheel Sets the action that the mouse wheel performs when used.
Middle Button Sets the action that the mouse middle button performs when used.
Right Button Sets the action that the mouse right button performs when used.
Shift +Left Button Sets the action that occurs when pressing Shift on the keyboard and clicking
the left mouse button simultaneously.
Shift +Middle Button Sets the action that occurs when pressing Shift on the keyboard and clicking
the middle mouse button simultaneously.
Shift +Right Button Sets the action that occurs when pressing Shift on the keyboard and clicking
the right mouse button simultaneously.
Ctrl +Left Button Sets the action that occurs when pressing Ctrl on the keyboard and clicking
the left mouse button simultaneously.
Ctrl +Middle Button Sets the action that occurs when pressing Ctrl on the keyboard and clicking
the middle mouse button simultaneously.
Ctrl +Right Button Sets the action that occurs when pressing Ctrl on the keyboard and clicking
the right mouse button simultaneously.
Ctrl +Shift +Left Button Sets the action that occurs when pressing Ctrl+Shift on the keyboard and
clicking the left mouse button simultaneously.

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

Preference Description
To Zoom In Closer Sets whether to zoom on a model by moving the mouse in or out.
Dynamic Viewing During When selected, a short animation shows the model moving/twisting
Rotation toward its final pose if you make a standard view change (such as front,
back, left, right, bottom, top, isometric, and Look At Face/Plane/Sketch).

This check box is selected by default. Clear this check box if you are
using an older graphics card.
Use Spaceball When selected, enables the use of the Spaceball 3D import device (not
supported in UNIX). This check box is selected by default.
Extend Selection Angle Sets a limit in degrees for what kind of face and edge angles the system
Limit considers smooth. This affects the Extend to Adjacent and Extend to Limits
Extend Selection toolbar buttons in DesignModeler. Extend Selection buttons
are also present in the Mechanical application.

The default value is 20° and the range is from 0° to 90°.


Angle Increment for Sets the angular increment of the Configure tool when defining a joint.
Configure Tool

Journals and Logs


From Tools → Options → Journals and Logs, you can specify the following.

Preference Description
Record Journal File When selected, records a journal file (p. 258) (.wbjn) for each Workbench
session and enables the other journal options.
Journal File Directory Selects the directory where journal files are written.

On Windows, the directory preference defaults to %TEMP%\Workbench-


Journals.

On Linux, the directory preference defaults to the following, in order:

1. $TEMP/WorkbenchJournals

2. $TMP/WorkbenchJournals

3. $HOME/.ansys/WorkbenchJournals

If you record a session for future playback, the same information is


written to both the location specified here and to the file specified
when you begin recording.
Days to Keep Journal File Sets the number of days to keep journal files. The default is 7.
When running a journal When selected, adds a pause after each command when running a journal
file, pause after each file. Also enables the Seconds to Pause field.
command
Seconds to Pause Sets the number of seconds to pause between commands. The default is 1.

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

Preference Description
Write Workbench Log Files When selected, writes two log files for each Workbench session and
enables the other log file options. The two files are:

• UIEventsprocID.log

• CoreEventsprocID.log

where procID is the process ID of the Workbench session. To identify


the log file of the most recent session, it is most convenient to sort the
directory by date. The log file contains information that is useful to
technical support whenever an error is encountered. Other applications
may continue to write log files to their own directories, even if launched
from Workbench.
Workbench Log Files Selects the directory where log files are written.
Directory
On Windows, the directory preference defaults to %TEMP%\Workbench-
Logs.

On Linux, the directory preference defaults to the following, in order:

1. $TEMP/WorkbenchLogs

2. $TMP/WorkbenchLogs

3. $HOME/.ansys/WorkbenchLogs

The log file directory preference takes effect immediately when the
Options dialog is closed.
Days to Keep Workbench Sets the number of days to keep log files. The default is 7.
Log File

Project Reporting
From Tools → Options → Project Reporting, you can set if exported reports automatically open in a
browser (p. 272) when they are generated.

Solution Process
From Tools → Options → Solution Process, you can specify the defaults for many of the solution
process properties of Solution cells. For projects with parametric design points, these settings also
control the defaults for the design point update process setting for the Parameter Set bar. For more
information on using these properties to submit a job to Remote Solve Manager (RSM), see Submitting
Solutions to Remote Solve Manager (p. 329).

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

Preference Description
Default Update Option Sets how the solution is run by default. Select from the following:

• Run in Foreground: The solution runs within the current Workbench


session.

• Run in Background: The solution runs in the background on the


local machine. This option is available only for Solution cells that
support background execution.

• Submit to Remote Solve Manager: The solution runs in the


background either on the local computer or, if Remote Solve Manager
is configured, on one or more remote computers. If you submit to
RSM, the solution continues to run even if you close the current
Workbench session.

If you have not defined configurations in RSM, or obtained configurations


from your RSM administrator, see RSM Configuration in the Remote Solve
Manager User's Guide.
Default Design Point Specifies the starting condition of each design point for design point updates.
Update Order By default, when each design point is updated, the design point is initialized
with the data of the design point designated as Current (except for retained
design points with valid retained data, which do not require initialization
data). However, 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 each time.

• Update From Current: Causes each design point to be initialized


from the Current design point. This is the default value.

• Update Design Points in Order: Causes each design point to be


initialized from the previous design point.

If you selected One Job for Each Design Point in the Default Job
Submission field, the Default Design Point Update Order is applicable
only if you also selected Geometry in the Pre-RSM Foreground Update
field.

This setting takes effect the next time you create a new project. See
Changing the Design Point Update Order (p. 316) for more information.
Show Advanced Solver When selected, enables the Interconnect and MPI Type parallel run settings
Options available for Fluent RSM runs. These settings require that the remote compute
servers can accept the Interconnect and MPI Type that you specify;
compatibility is not checked automatically.
Retained Design Point Specifies how an update is performed for retained design points. Select one
of the following options:

• Update parameters: Only parameters are updated for retained design


points. If a component is not needed to get the value of an output
parameter, it is not updated. This is the default value.

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

Preference Description
• Update full project: Full project is updated for retained design points.
Use this setting if you want to generate reports, or other content,
from components that do not produce output parameters.

Default RSM Queue Sets the RSM queue that is selected by default when you select the Submit
to Remote Solve Manager update option. The list of available queues
depends on the configurations that are available in the RSM configuration
directory. See Sharing and Accessing RSM Configurations in the Remote Solve
Manager User's Guide.
Default Job Name Sets the default name that appears in the Job Name field. The name must
start with an alphanumeric character, must not contain spaces or the
characters ! @ $ * ? \ and must not be longer than 15 characters.
Download Progress When selected, enables the solver monitor to periodically query RSM for
Information by Default output files in order to display progress (where applicable).
Default Progress Specifies the time interval, in seconds, between solver queries to RSM in
Download Interval order to display progress. The default is 30. Setting this value to zero (0)
(Seconds) results in continuous queries; that is, as soon as files are downloaded from
the compute server, Workbench immediately queries again. This option is
available for CFX systems only.
Default Execution Mode Specifies if you want the solution to run in serial or parallel mode. The default
is Serial. The parallel option is available only if the selected solver supports
parallel execution mode.
Default Number of Specifies the default number of processes to use if you choose to run in
Processes parallel mode. Must be set to 2 or greater.
Pre-RSM Foreground Specifies how geometry is handled before submitting project updates to
Update RSM. Select one of the following options:

• None: Submits project updates to RSM without updating the geometry


locally.

• Geometry: Updates your geometry locally before submitting project


updates to RSM.

Extensions
From Tools → Options → Extensions, you can configure settings for Ansys ACT extensions.

For more details on these options, see Extension Configuration in the ACT Developer's Guide.

Preference Description
Additional Extension Folders Defines the additional folders where ACT searches for the extensions that
the Extension Manager displays. You can define several folder names,
separating them with a semicolon (;).
Save Binary Extensions with Specifies whether to save binary extensions within the project when the
Project project is saved.

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

Preference Description
Debug Mode When selected, enables debug mode for IronPython scripts of loaded
extensions.

Mechanical APDL
From Tools → Options → Mechanical APDL, you can specify the following.

For more details on these options, see The File Management Tab in the Operations Guide.

Preference Description
Command Line Options Sets the startup command line options.
Database Memory (MB) Specifies the portion (in megabytes) of total memory that the database
uses for the initial allocation. The default is 1024.
Workspace Memory (MB) Specifies the initial allocation of memory (in megabytes) requested for the
Mechanical APDL run. The default is 2048.
Utilized cores Sets the number of cores used for parallel processing.
Job Name Defines the base filename used for all files generated by the Mechanical
APDL session. The default is file. You can change it to any alphanumeric
string up to 32 characters long.
License Sets the default license level.
Graphics Device Sets the graphics device. The user interface requires a terminal that supports
graphics.
Distributed When selected, activates distributed computing settings.
Machine List Specifies machine information for distributed computing.
GPU Accelerator Provides access to the Graphics Processing Unit (GPU) acceleration capability
offered in the Project Schematic and inside Mechanical APDL. Three options
are available, None, NVIDIA and AMD. The default is None.

Selecting this option from Options → Mechanical APDL applies the


setting to all newly added systems in the Project Schematic. You can
override these settings by changing the GPU Accelerator selection on
individual systems by right-clicking Analysis and editing the properties.
Number of GPUs per Specifies the number of GPUs each machine has. The default is 1.
Machine
Read START.ANS When selected, reads the start.ans file at start-up.
Custom Executable Path Sets a custom Mechanical APDL executable to start in the launcher.
Download Distributed Files When selected, downloads all distributed files.

CFX
From Tools → Options → CFX, you can specify the following.

For more details on these options, see Properties Pane in the CFX Introduction.

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

Preference Description
Keep Latest Solution Data When selected, deletes any associated old solution data automatically
Only after updating the Solution cell.
Cache Solution Data When selected, retains cached solution data for non-current design
points (in addition to the current design point) after they are solved.
Initialization Option Sets how data is gathered to initialize the solution.
Execution Control Conflict Sets the option used to resolve execution control conflicts.
Option
For more information, see Troubleshooting in the CFX Introduction.

Design Exploration
From Tools → Options → Design Exploration, you can specify the following.

Preference Description
Show Advanced Options When selected, displays advanced properties (in italics) for certain
DesignXplorer objects in the Properties pane.
Preserve Design Points after When selected, saves design points created for a design exploration cell to
DX Run the project’s design points table once the solution completes. Also enables
the Retain Data for Each Preserved Design Point check box.
Retain Data for Each When selected, retains data for each design point saved in the project’s
Preserved Design Point design point table.
Retry All Failed Design When selected, enables additional attempts to solve design points that
Points failed to update during the first run. Also enables Number of Retries and
Retry Delay (seconds).
Number of Retries Sets the number of times to try to update failed design points. The default
is 5.
Retry Delay (seconds) Sets the number of seconds to elapse between tries. The default is 120.
Chart Resolution Sets the number of points for a continuous input parameter axis in a 2D
or 3D Response Surface chart. The range is from 2 to 100. The default is
25. Increasing the number of points enhances the chart resolution.
Significance Level Sets the relative importance or significance to assume for input variables.
The allowable range is from 0.0 to 1.0, where 0 means that all input
variables are assumed to be insignificant and 1.0 means that all input
variables are assumed to be significant. The default is 0.025.
Correlation Coefficient Sets the calculation method for determining sensitivity correlation
Calculation Type coefficients. The default is Rank Order (Spearman).
Display Parameter Full When selected, displays full parameter names rather than short parameter
Name names.
Parameter Naming Sets the naming style for input parameters within design exploration. The
Convention default is Uncertainty Management Style.

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

Preference Description
Confirm if Min-Max Search When selected, displays an alert before performing a Min-Max search
can take a long time operation when there are discrete input parameters to warn that the search
could be time-consuming.

Note:

If you expand Design Exploration in the tree, you will see three child tabs: Design of
Experiments, Response Surface, and Sampling and Optimization. For more information
about the options on all four DesignXplorer tabs, see Design Exploration Options in the
DesignXplorer User's Guide.

Distributed Compute Services


From Tools → Options → Distributed Compute Services, you can specify the following.

Preference Description
Server URL Sets the URL for starting the DCs server. The default for starting a local server
is https:/localhost/dcs. The format of a URL for starting a remote
server is https://hostname:port/dcs or https://IPad-
dress:port/dcs.
Auto-Start Local Evaluator When selected, automatically starts an evaluator on the local machine when
design point updates are requested. This check box is selected by default.
If you clear this check box, you can start the evaluator on the local machine
by going to the Windows Start menu and selecting DC Evaluator. You can
also start it from the command line by typing dclauncher.exe start
evaluator.

HPC Platform Services


From Tools → Options → HPC Platform Services, you can specify the following.

Preference Description
HPC Platform Services Sets the URL for connecting to the HPC Platform Services server. The default
Server URL for a local server is https:/localhost:8443/rep. The format of a URL
for a remote server is https://hostname:port/rep or https://IPad-
dress:port/rep.

External Data
From Tools → Options → External Data, you can specify the following.

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

Preference Description
Files Import Type Sets how the External Data file is handled when importing External
Data (p. 113).

• By Copy: Copies the External Data file into the project folder.

• By Reference (default): Directly references the External Data file. For


large size files, this drastically reduces disk storage requirements and
improves performance.

Fluent
From Tools → Options → Fluent, you can specify the following.

General options apply to all Fluent-based systems in the Workbench project, regardless of whether the
system was created before, or after, the option is enabled. Note that these options are not saved with
the project, and the settings are always applied to the currently loaded project.

Default options for new Fluent system apply to all newly created Fluent-based systems in the Workbench
project. They can be overridden by editing the properties specified for the Setup and Solution cell.
The settings specified in the Setup and Solution cell properties are always respected and saved with
the Workbench project. Therefore, for previously saved projects, these saved settings are used.

Preference Description
General Options
Show Warning on Editing When selected, displays a warning message when solution data exists and
Setup if Solution Has you attempt to open Fluent from the Setup cell.
Current or Initial Data
When you open Fluent from the Setup cell, the mesh and settings file
associated with the Setup cell are loaded into Fluent which may or
may not be what you want.

The check box is selected by default.


Automatically Delete Old When selected, old solution data is automatically removed when starting
Solutions On Start Of New a new computation.
Calculation
The check box is selected by default.
Reuse Fluent Session for When selected, reuses the Fluent session for other design point calculations.
Design Points This option works with foreground parametric updates only.

The check box is cleared by default.


Default Options for New Fluent System
Show Launcher at Startup When selected, displays the Fluent Launcher when Fluent starts.

The check box is selected by default.

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

Preference Description
Display Mesh After Reading When selected, displays the mesh after the mesh or case/data is read into
Fluent.

The check box is selected by default.


Embed Graphics Windows When selected, embeds the graphics windows in the Fluent application
window.

When cleared, unlocks the graphics windows so they are free-standing.

The check box is selected by default.


Use Workbench Color When selected, sets the graphics window to the Workbench color scheme.
Scheme
When cleared, sets the graphic window to the classic black background
color.

The check box is selected by default.


Set up Compilation When selected, allows you to specify compiler settings for compiling
Environment for UDF user-defined functions (UDFs) with Fluent.

The check box is selected by default.


Precision Sets either the single-precision or the double-precision solver.
Enable Generation of Setup When selected, bypasses loading the mesh and setting files and reapplying
Output Case File the pre-set mesh operations every time the Setup cell is edited, resulting
in faster runs.

This option is especially beneficial when computing simulations across


multiple design points involving Fluent-related parametric changes.
The Fluent solver automatically generates the output case file,
name-Setup-Output.cas, every time you modify the mesh, set
mesh operations prior to running the simulation in Fluent, or start a
Fluent session with a mesh file only.

The generated output case file is used when launching the next Fluent
session from the Setup cell if the regular case file is out-of-date or not
available.

The check box is selected by default.


Enable Solution Monitoring When selected, allows you to be graphically view Fluent solution
convergence and monitor data without having Fluent open.

Once this option is enabled, you can use the Show Solution
Monitoring option in the Solution cell context menu to display
convergence and monitor charts.

This check box is selected by default.


Enable Generation of When selected, Instructs the Fluent solver to automatically generate an
Interpolation File interpolation file, *.ip, at the end of the run. Unlike the *.dat file, the
*.ip file can be used to restart the Fluent session, even if the mesh has
been modified

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

Preference Description
This check box is cleared by default.

Mechanical
From Tools → Options → Mechanical, you can specify the following.

Preference Description
Auto Detect Contact On When selected, enables computed contact detection when geometry is
Attach imported into Mechanical.

This check box is enabled by default.


Save Mesh Data In When selected, enables the default setting for the Save Mesh Data In
Separate File Separate File property in Mechanical systems (such as Static Structural) for
subsequently created Mechanical systems. The property setting controls
whether mesh data is stored in a separate .acmo file for the current system.

Saving the mesh data in a separate file reduces the overall file space
required and reduces the possibility of disc corruption in very large
database files on Linux systems.
Connect/Run Python Code When selected, connects to and runs Python Code objects after launching
Objects When Mechanical Mechanical.
is Launched
Close Mechanical During When selected, stops the Mechanical application from opening and
Launch If No License displays a message if no license is available in the queue or if the license
checkout process fails. Selecting this preference is beneficial when you
are working with a large model that requires a lot of time to open.

. You can obtain license failure information in the licensing debug file.
See the Getting Additional License Debug Information section of the
Ansys Licensing Guide for more information.

When cleared, opens Mechanical in read-only mode (p. 236).


Release License for Specifies when the Mechanical application releases its license when running
Pending Jobs in batch mode:

• On Demand: When the Solution cell for a Mechanical system is in


the pending state during a batch run, the right-click menu has a
Release License option. This closes the Mechanical application but
does not interfere with the completion of the run. (Default)

• Always: Causes the Mechanical application to automatically close


and release its license during batch runs when the Solution cell is
in the pending state.

• Design Point Run Only: Causes the Mechanical application to


automatically close and release its license during Update All Design
Points runs when the Solution cell is in the pending state.

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

Preference Description
Maximize Design Point When selected, causes Mechanical not to copy design point results data
Performance when parameters are changed in Mechanical simulations, as the design
points are re-evaluated in those cases.

Note that no working directory files (such as macros) are copied, so to


use this setting you must move any files that you have put into the
working directory (the solver files directory) to the user_files
directory.
Remote Job Status Check Sets the number of seconds between each query to Remote Solve Manager
Interval in Seconds for the Mechanical solution update job status. The default is 20. This setting
only takes effect when the Mechanical solution is submitted to RSM.
During a design point When selected, directs the Mechanical application to automatically restart
update, periodically restart after the specified number of design points when running in batch mode.
the Mechanical application
Each restart resets the Mechanical application and slightly lengthens
the processing time, but can improve overall system performance
(memory and CPU) when the generation steps of each design point
(geometry, mesh, solve, post processing) are long. In such cases, specify
a low number of design points before restarts.

In cases where the generation steps for each design point are short,
reduce processing time by increasing the number of design points
before restarts or prevent restarts completely by disabling this
preference.
Number of design points Sets the number of design points to update when the During a design
to update before restarting point update, periodically restart the Mechanical application check box
the Mechanical application is selected. The default is 1.
Limit Number of Cores for When selected, sets the number of cores used by the data transfer mapping,
Data Mapping and interpolation operations and result postprocessing to a user-specified value.
Post-Processing
Maximum number of cores Sets the maximum number of cores used when the Limit Number of Cores
for Data Mapping and Post-Processing check box is selected. The default
is 2.
Beta features selection Select one or more check boxes to enable Mechanical beta features in
Workbench.

Meshing
From Tools → Options → Meshing, you can specify the following.

Preference Description
Auto Detect Contact On When selected, enables contact detection computing when geometry is
Attach imported into Meshing.

This check box is selected by default.


Save Mesh Data In When selected, enables the default setting for the Save Mesh Data In
Separate File Separate File property in Mechanical systems (such as Static Structural) for

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

Preference Description
subsequently created Mechanical systems. The property setting controls
whether mesh data is stored in a separate .acmo file for the current system.

Saving the mesh data in a separate file reduces the overall file space
required and reduces the possibility of disc corruption in very large
database files on Linux systems.
Close Meshing During When selected, stops the Meshing application from opening and
Launch If No License displays a message if no license is available in the queue or if the license
checkout process fails. Selecting this preference is beneficial when you
are working with a large model that requires a lot of time to open.

. You can obtain license failure information in the licensing debug file.
See the Getting Additional License Debug Information section of the
Ansys Licensing Guide for more information.

When cleared, opens Meshing in read-only mode.


During a design point When selected, directs the Meshing application to automatically restart after
update, periodically restart the specified number of design points when running in batch mode.
the Meshing application
Each restart resets the Meshing application and slightly lengthens the
processing time, but can improve overall system performance (memory
and CPU) when the meshing of each design point is long. In such cases,
specify a low number of design points before restarts.

In cases where the meshing step for each design point are short, reduce
processing time by increasing the number of design points before
restarts or prevent restarts completely by disabling this preference.
Number of design points Sets the number of design points to update when the During a design
to update before restarting point update, periodically restart the Meshing application check box is
the Meshing application selected. The default is 1.

Engineering Data
From Tools → Options → Engineering Data, you can specify the following.

Preference Description
Filter toolbox content for When selected, filters Toolbox content based on your selection in the
selection Properties pane.
Unset the default material When selected, clears the default material used when materials are
when materials are imported imported with geometry attached.
with geometry.
Consolidate materials on When selected, consolidates the material information when it is imported
import into Workbench.

Ansys Minerva
From Tools → Options → Ansys Minerva, you can specify the following.

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

Preference Description
Authentication Sets the method to used to authenticate with Ansys Minerva. Select the method
Type that matches what is configured for the Ansys Minerva server. Select from the
following options:

• Basic—Uses a username and password to authenticate using the internal


mechanism within Ansys Minerva.

• Browser—Uses the browser to authenticate. If you are logged into Ansys Minerva
in the browser, those credentials are used.

• Windows—Uses Active Directory to pass the credentials of the user currently


logged into the Ansys Minerva server.

Server URL Sets the URL of the Ansys Minerva server that Workbench connects to.
Database Sets the name of the Ansys Minerva database to access.

Microsoft Office Excel


From Tools → Options → Microsoft Office Excel Options, you can specify the following for the Microsoft
Office Excel add-in.

Preference Description
Named Ranges Filtering Sets a prefix to filter which Excel named ranges are exposed as parameters
Prefix in a Workbench project.

All named ranges defined in the Excel file that include that prefix are
displayed as parameters in the project. By default, this setting is blank
(no filter).

If you specify a prefix, the prefix is used to filter the named ranges for
all new design exploration systems. For example, if you set this option
to WB, the Named Range Key property (in the Setup section of the
Properties pane of the Microsoft Office Excel Analysis system) is set to
WB for all new projects you create.

If you have specified a different filtering prefix the project level in the
Named Range Key property, the project-level setting is not affected by
changes to this option.

TurboSystem
From Tools → Options → TurboSystem, you can specify the following.

Preference Description
Include inlet/outlet domains When selected, causes subsequently created Turbo Mesh cells to have the
in Turbo Mesh cells by Meshing → Inlet Domain and Meshing → Outlet Domain properties
default initially selected.

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

Preference Description
Data transfer type Controls the default value of the Data Transfer → Geometry Transfer
Type property of subsequently created Blade Design cells.

Geometry Import
From Tools → Options → Geometry Import → Geometry Import, you can specify the following.

Preference Description
Preferred Geometry Editor Sets the geometry editor. You can select from DesignModeler or SpaceClaim
Direct Modeler (default).

Note:

The SpaceClaim Direct Modeler option is not available when


the Use SpaceClaim Direct Modeler as an External CAD
option is enabled.

CAD Licensing Sets how the CAD license is kept or released.

• Hold: Instructs Workbench to keep the license after the import or


refresh operation has completed. The option is useful when executing
design studies.

If the Hold option was previously set and subsequently changed to


Release, the license is released immediately after clicking OK in the
Options dialog box. A plug-in license that is held is always released
when exiting the Workbench session.

• Release (default): Instructs Workbench to free the license for someone


else's use after the import or refresh operation has completed.

Note:

The CAD Licensing option is not supported for geometry


import into SpaceClaim Direct Modeler. Regardless of the
setting of CAD Licensing, SpaceClaim Direct Modeler always
releases its CAD licenses after importing.

Use SpaceClaim Direct When selected, SpaceClaim is controlled as an external CAD system, with
Modeler as an External no direct integration into the Project Schematic.
CAD
When cleared, SpaceClaim is fully integrated into the Project Schematic
as a geometry editor.

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

Preference Description
This check box is cleared by default.

Note:

• Switching this preference from within an active project


could result in project schematic inconsistencies and
undesired behavior. We recommend that you set this
preference during project creation and ensure that all users
interacting with the project do not change it.

• If the preference must be changed, the Geometry systems


that reference SpaceClaim geometry should be Reset and
reconfigured to properly release any previously stored
parameters and file references.

• You cannot use SpaceClaim with meshing tools enabled


as an external CAD system. If the meshing options are
enabled and this preference is selected, the following error
message is displayed when you connect to a downstream
system:

Can not use SpaceClaim w/Meshing as an


external CAD system. Please change your
settings.

Use Workbench Project When selected, SpaceClaim Direct Modeler adopts the units of the Workbench
Units for Length and project when it is launched from Workbench.
Angle
Use Workbench Language When selected, SpaceClaim Direct Modeler adopts the language used by
Settings Workbench when it is launched from Workbench Project Schematic.
Geometry editor behavior Controls the visibility of the geometry editor during a design point update.
during update
• Default: The update is run in batch mode. If the geometry editor was
open prior to the update, it is reopened at the completion of the
update.

• Run interactively: Forces the geometry editor to be run interactively


for the entire update. If the geometry editor was open prior to the
update, it is reopened at the completion of the update.

• Run in batch mode: Forces the geometry editor to be run in batch


mode for the entire update. The geometry editor is left closed at the
completion of the update.

Keep the geometry editor When selected, directs the geometry editor to stay open (in batch or
running for optimized interactively based on the setting of Geometry editor behavior during
design point updates update) and use the same session during a design point update. Allows for

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

Preference Description
quicker processing time as the geometry editor is not restarted after each
design point.
Periodically restart the When selected, directs the geometry editor to automatically restart after the
geometry editor specified number of design points (as specified by the setting of Number
of design points to update before restarting the geometry editor).
Number of design points Sets the number of design points that are updated before the geometry
to update before editor is restarted. The default is 0, which executes the same as if this
restarting the geometry preference were disabled.
editor
Each restart resets the geometry editor and slightly lengthens processing
time, but can improve overall system performance (memory and CPU)
when the time needed for the geometry update of each design point
is long. In such cases, specify a low number (1 or more) of design points
before each restart. In cases where the time needed for the geometry
update of each design point is short, reduce processing time by
increasing the number of design points before each restart, or prevent
restarts completely by disabling this preference.
Basic options For detailed descriptions of the basic geometry import options, see the Basic
Geometry Options table in Geometry Preferences.
Advanced options For detailed descriptions of the advanced geometry import options, see the
Advanced Geometry Options table in Geometry Preferences.

Material Designer
From Tools > Options > Material Designer, you can specify the following:

Preference Description
Material Designer Controls the visibility of Material Designer during a design point
behavior during update.
update
• Default: The update is run in batch mode. If Material Designer
was open prior to the update, it is reopened at the completion
of the update.

• Run interactively: Forces Material Designer to run interactively


for the entire update. If Material Designer was open prior to
the update, it is reopened at the completion of the update.

• Run in batch mode: Forces Material Designer to run in batch


mode for the entire update. Material Designer is left closed at
the completion of the update.

Keep Material When selected, directs Material Designer to stay open (in batch
Designer running or interactively, based on the setting of Material Designer be-
for optimized design havior during update) and use the same session during a design
point updates point update. Allows for quicker processing time as Material
Designer is not restarted after each design point.

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

Preference Description
Periodically restart When selected, directs Material Designer to restart automatically
Material Designer after the specified number of design points (as specified by the
setting Number of design points to update before restarting
Material Designer).
Number of design Sets the number of design points that are updated before
points to update Material Designer is restarted. The default is 0, which executes
before restarting the as if this preference were disabled.
Material Designer
Each restart resets Material Designer and slightly lengthens
processing time, but restarts can improve overall system
performance (memory and CPU) when the time needed for the
update of each design point is long. In such cases, specify a low
number of design points (1 or more) before each restart.

In cases where the time needed for the update of each design
point is short, you can reduce processing time by increasing the
number of design points before each restart, or you can prevent
restarts by disabling this preference altogether.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
454 of ANSYS, Inc. and its subsidiaries and affiliates.
Workbench Interface Reference
The following user interface components are discussed in detail:
Tabs in Workbench
Panes within Tabs
Cells in Workbench
Menus in Workbench

Tabs in Workbench
Tabs are workspaces that allow you to interact with different parts of your project. Most cells of a system
open in separate windows outside of the Workbench application; the following is a list of tabs for systems
and cells that open within Workbench.

• 3D ROM

• Analysis (p. 196) (Mechanical APDL)

• Analysis (p. 210) (Microsoft Office Excel)

• System Coupling (p. 224)

• Design of Experiments

• Direct Optimization

• Engineering Data

• External Data (p. 112)

• External Model (p. 133)

• Parameter Set (p. 304)

• Parameters Correlation

• Project (p. 49)

• Response Surface

• Response Surface Optimization

Panes within Tabs


Workbench provides the following categories of panes.

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

Common Panes
Common panes are ones that are included on multiple tabs, but are configured per tab. changes to the
pane on one tab are not reflected on other tabs of the same sort, the pane contains different data on
each tab.

The following common panes are available:

• Project Schematic Pane (p. 456)

• Toolbox Pane (p. 457)

• Toolbox Customization Pane (p. 459)

• Files Pane (p. 459)

• Outline Pane (p. 459)

• Properties Pane (p. 460)

• Table Pane (p. 461)

• Chart Pane (p. 461)

• Scene Pane (p. 461)

• Solution Information Pane (p. 461)

Persistent Panes
Persistent panes remain configured as you have specified when you navigate between tabs. For example,
if you display a persistent pane in one tab, then switch to a different one, the persistent pane remains
visible in the second tab.

The following persistent panes are available:

• Messages Pane (p. 462)

• Progress Pane (p. 462)

• Sidebar Help (p. 463)

Project Schematic Pane


Located in the Project tab, the Project Schematic pane is the main workspace for your project.

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

Opening the Properties pane allows you to manage the following properties for the Project
Schematic pane.

Property Description
Notes Displays all project notes (p. 247)
created.

Toolbox Pane
Located in the Project tab, the Toolbox pane contains the types of data you can add to your project.

To add data, you take the systems located in the Toolbox pane and add them to the Project
Schematic pane.

Systems are divided into categories which can be expanded or collapsed to show or hide the systems
in that category. You can select systems from the following categories:

• Analysis Systems (p. 76)

• Component Systems (p. 105)

• Custom Systems (p. 228)

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

• Design Exploration (p. 234)

The contents of each category are determined by which products you have installed and what licenses
are available. If you do not have a particular product installed or do not have an available license,
the individual systems corresponding to that product are not shown in the Toolbox.

For detailed information on system categories and individual systems, see Working Through a Sys-
tem (p. 69).

Additionally, you can customize the Toolbox further, specifying that only some of the available systems
are visible. For customization details, see Configuring the Toolbox (p. 27).

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

The Toolbox pane persists across tabs. It contains systems on the Project tab, but on other tabs it
contains other sorts of information, such as charts, and engineering materials.

Toolbox Customization Pane


The Toolbox Customization pane enables you to specify which systems display in the Toolbox. For
more information, see Configuring the Toolbox (p. 27).

Files Pane
The Files pane shows a list of all files associated with, and added to, 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.

For more information on how to manage and work with the files shown in the pane, see Working in
the Files Pane (p. 280).

Outline Pane
When data is available for an item, the Outline pane presents data in a summary form. You can access
the Outline pane in the Project tab, the Parameter Set tab, the Parameters tab, or the tab for any
cell in a Design Exploration or Engineering Data system.

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

To open the Outline pane, double-click the Parameter Set bar or a system cell. Or, right-click the
cell and select Edit from the context menu.

Examples of the Outline pane include the Outline of All Parameters in the Parameter Set tab and
the Outline of Schematic in an application tab.

For information about using the Outline pane for parameters and design points, see Working with
Parameters and Design Points (p. 289).

Properties Pane
The Properties pane enables you to see properties for the Project Schematic, systems, cells, and
schematic links.

The specific items shown in the Properties pane varies according to what you have selected.

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

In some cases, it displays basic information about the component that cannot be modified from the
Properties pane. For example, if you choose to view properties on a link between systems, a list of
uneditable connection properties (for example, type and from/to cell identifiers) is displayed.

In other cases, the Properties pane displays detailed information that can be edited. For example, if
you choose either Edit or Properties from the Vista TF Setup cell, a fully-editable list of properties
is displayed.

If more information on a specific Properties pane is available, you can view the quick help for the
cell for which you are viewing properties.

Table Pane
When the Table pane is included in a tab, it allows you to view project data in table format. Examples
of the Table pane are the Table of Design Points in the Parameter Set tab and the Table of
Properties in an Engineering Data tab.

Some tables are editable and some are not. In general, if you can add a new row, you an asterisk is
displayed (*) in the last row. If a cell is editable, you can double-click in the cell to select the content
and change it. In some tables, columns may include a drop-down menu of additional actions that
are available for that column. Tables for different applications and different purposes have different
features and behavior. See the documentation for the specific application for details on using tables.

Chart Pane
When the Chart pane is included on a tab, it enables you to view charts that have been added and
generated for the project. Each type of tab has different charts available. For example, the Parameter
Set tab has a different set of charts than the DesignXplorer Parameters Correlation tab has.

For more information about using charts, see Working with the Chart Pane (p. 261).

Scene Pane
The Scene pane is available in the Fluent interface. To activate the Scene pane, enable Show Solution
Monitoring from Fluent (right-click the Solution cell of a Fluent system to open the Fluent Solution
Monitor). For more information, see Monitoring Fluent Solutions in Workbench in the Fluent in
Workbench User's Guide.

Solution Information Pane


The Solution Information pane is available in the System Coupling or Fluent system’s interface. For
more information, see System Coupling User's Guide or Fluent in Workbench User's Guide.

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

Messages Pane
The Messages pane displays any messages you have, such as error and warning messages, solver
messages, status messages, and so on.

During any update (cell, system, project, design point, multiple design point), any messages that are
generated are displayed in the Messages pane. The Messages pane opens automatically if an error
message occurs during an update, but in other situations you must open it manually.

You can display or hide the Messages pane by clicking Show Messages or Hide Messages in the
lower right corner of any Workbench tab.

Progress Pane
The Progress pane displays a progress bar during an update. You can display or hide the Progress
pane by clicking Show Progress or Hide Progress in the lower right corner of the window. You can
also interrupt an update process (p. 251).

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

Sidebar Help
The Sidebar Help pane displays context sensitive help text and links. For more information on using
this pane, see Using Help (p. 24).

Cells in Workbench
The systems that you add to the Project Schematic are made up of one or more cells.

Related topics:
Types of Cells
Understanding Cell States
Cell Properties

Types of Cells
The following common types of cells occur in many of the analysis and component systems available
in Workbench; Other cell types may be available in certain systems; see the application-specific doc-
umentation in Working Through a System (p. 69) for these cell descriptions.

Engineering Data
Use the Engineering Data cell with Mechanical systems or the Engineering Data component sys-
tem (p. 111) to define or access material models for use in an analysis. To define material data, open
the Engineering Data tab by either double-clicking the Engineering Data cell or right-clicking the

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

cell and selecting Edit from the context menu. For more information, see Overview in the Engineering
Data User's Guide.

Geometry
Use the Geometry cell to import, create, edit or update the geometry model used for analysis. Right-
click the cell to access these functions in the context menu. The right-click options are context sens-
itive and change as the state of your geometry changes, so not all of the options are available at all
times.

Note:

The SpaceClaim Direct Modeler features are available only if you have SpaceClaim Direct
Modeler installed and the Ansys SpaceClaim Direct Modeler license available.

Model/Mesh
The Model cell in the Mechanical application analysis systems or the Mechanical Model component
system is associated with the Model branch in the Mechanical application and affects the definition
of the geometry, coordinate systems, connections and mesh branches of the model definition.

When linking two systems, you cannot create a share between the Model cells of two established
systems. You can generate a second system that is linked at the Model cell of the first system, but
you cannot add a share after the second system has been created. Likewise, you cannot delete a link
between the Model cells of two systems.

The Mesh cell in Fluid Flow analysis systems or the Mesh component system (p. 206) is used to create
a mesh using the Meshing application. It can also be used to import an existing mesh file.

Setup
Use the Setup cell to launch the appropriate application for that system. You define your loads,
boundary conditions, and configure your analysis in the application. The data from the application
is incorporated into the project in Workbench, including connections between systems.

Solution
From the Solution cell, you can access the Solution branch of your application, and you can share
solution data with other downstream systems (for instance, you can specify the solution from one
analysis as input conditions to another analysis). If you have an analysis running as a remote process,
the Solution cell is in a Pending (p. 465) state until the remote process completes.

Results
The Results cell indicates the availability and status of the analysis results (commonly referred to as
postprocessing). From the Results cell, you cannot share data with any other system.

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

Understanding Cell States


Workbench integrates multiple applications into a single, seamless project flow, where individual cells
can obtain data from and provide data to other cells. As a result of this flow of data, a cell's state can
change in response to changes made to the project. Workbench provides visual indications of a cell's
state at any given time with icons on the right side of each cell.

Typical Cell States


State Icon Description
Unfulfilled Required upstream data does not exist. Some applications may
not allow you to open them with the cell in this state. For
example, if you have not yet assigned a geometry to a system,
all downstream cells appear as unfulfilled, because they cannot
progress until you assign a geometry.
Refresh Upstream data has changed since the last refresh or update.
Required You may or may not need to update output data. When a cell
is in this state, you can edit the cell, refresh the data, update
upstream components, or update the cell.

The advantage to refreshing rather than updating a cell is


that you are alerted to potential effects on downstream
cells and make any necessary adjustments before you
update it. This option is especially useful if you have a
complex system in which an update could take significant
time and computer resources.
Attention All of the cell's inputs are current. However, you must take a
Required corrective action to proceed. To complete the corrective action,
you may need to interact with this cell or with an upstream cell
that provides data to this cell. Cells in this state cannot be
updated until the corrective action is taken.

This state can also signify that no upstream data is


available, but you can still interact with the cell. For
instance, some applications support an "empty" mode of
operation in which it is possible to enter the application
and perform operations regardless of the consumption of
upstream data.
Update Local data has changed and the output of the cell must be
Required updated.
Up to Date An update has been performed on the cell and no failures have
occurred. It is possible to edit the cell and for the cell to provide
up-to-date generated data to other cells.
Input Changes The cell is locally up-to-date but may change when next updated
Pending as a result of changes made to upstream cells.

Solution-Specific States
The Solution or Analysis cell for certain solvers can display the following solution-specific states.

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

State Icon Description


Interrupted, Indicates that you have interrupted the solution during an
Update update, leaving the cell paused in an update required state.
Required
This option performs a graceful stop of the solver, which
completes its current iteration. Although some calculations
may have been performed, output parameters are not
updated. A solution file is written containing any results
that have been calculated. The solve resumes with the next
update command.
Interrupted, Indicates that you have interrupted the solution during an
Up to Date update, leaving the cell in an up-to-date state.

This option performs a graceful stop of the solver, which


completes its current iteration. Output parameters are
updated according to the calculations performed so far, and
a solution file is written. You can use the solution for
postprocessing. For example, you can look at the
intermediate result. Because the cell is already up-to-date,
it is not affected by a design point update.
To resume the solve, right-click and select Continue Calculation
from the context menu.
Pending Signifies that a batch or asynchronous solution is in progress.
When a cell enters the pending state, you can interact with the
project to exit Workbench or work with other parts of the project.
If you make changes to the project that are upstream of the
updating cell, then the cell is not in an up-to-date state when
the solution completes.

Note:

When up-to-date cells are connected to cells in a different type of system, the state of the
up-to-date cells may change to Update Required. This behavior occurs because additional
files have to be generated to satisfy the newly added system.

For example, assume that you have built a fluid flow system (Fluid Flow (CFX)) that is up-
to-date.

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

If you then connect the Mesh cell to a fluid flow system (Fluent), the mesh files for CFX
Setup are the only files that will have been generated by the update process. After con-
necting another system to the up-to-date Mesh cell, the Mesh cell transitions to the update
required state to signify that additional files must be generated for satisfy the Fluent system.

The cells already connected to the Mesh cell transition to the refresh required state after
the Mesh cell is updated. Updating the project unnecessarily re-updates the previously
up-to-date cells (CFX Setup, Solution, and Results). We recommended that you establish
the connection to the Fluent system before updating components downstream of the
Mesh in the Fluid Flow (CFX) system.

Failure States
If a particular action fails, Workbench provides a visual indication as well. You can pane any related
error messages in the Messages pane by clicking Show Messages in the lower right portion of the
window.

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

State Icon Description


Refresh Failed, Refresh The last attempt to refresh cell input data failed and
Required the cell remains in a refresh required state.
Update Failed, Update The last attempt to update the cell and calculate
Required output data failed and the cell remains in an update
required state.
Update Failed, Attention The last attempt to update the cell and calculate
Required output data failed. The cell remains in an attention
required state.

Cell Properties
Every cell in Workbench has various properties associated with it. Most of these properties are specific
to the type of system, type of cell, and state of the cell, and are documented in the specific application
documentation. However, some cell properties are common across many cells, regardless of type of
system or cell state. Those properties are described here.

To pane cell properties, right-click the cell and select Properties from the context menu. The Prop-
erties pane opens, displaying all properties applicable to that cell in its current state. Both the property
name and its current value are shown. Some properties are editable, while others cannot be edited
because of the specific configuration of that project and/or cell.

Property Description
Component ID Displays the directory where any information associated with this component resides.
For more information on the general Workbench directory structure, see Project
Directories (p. 284).
Notes Displays all system and cell notes (p. 247) created.
Last Update Displays the license used by this component during the most recent update. If the
Used Licenses component does not require a license during an update, the value displayed is Not
Applicable.
Always Include Specifies that a component should be included in any design point update operation,
in Design Point even if it does not have output parameters. If you enable this property for a
Update component, the component is updated when you update design points, regardless
of whether parameter values are affected.

Used for CFD-Post components.


Save Mesh Controls whether the mesh data is stored in a separate .acmo file, rather than being
Data In stored in the database file, when you save your project. Saving the mesh data in
Separate File separate file reduces the overall file space required and reduces the possibility of
disc corruption in very large database files on Linux systems.

Used by the Model cell (non-fluid flow analyses such as Static Structural) and
by the Mesh cell (Fluid Flow analyses and Mesh components).

The default setting for this field is controlled by the Save Mesh Data In Separate
File setting in the Workbench Mechanical (p. 447) or Meshing (p. 448) options.

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

Menus in Workbench
The following types of menus are available in Workbench:
Menu Bar
Context Menus

Menu Bar
The menu bar gives you access to the following menus.

File Menu
Menu Item Description
New Creates a new project (p. 50).
Open Opens an existing project (p. 50).
Save Saves the current project (p. 275).
Save As Saves the current project (p. 275) under a different name and/or location.
Import Imports a legacy database (p. 53).
Archive Generates an archive file that contains all project files (p. 276).
Ansys Minerva Provides options for connecting to and working with Ansys Minerva
repositories (p. 407).
Scripting Opens a sub-menu containing journalling and scripting options (p. 257).
Export Report Writes out a report of the current project in .html/.htm format (p. 272).
Recently Viewed Displays the four most recently opened projects.
Files
Exit Closes Workbench. You are prompted to save any unsaved data.

View Menu
Menu Item Description
Refresh Updates the pane.
Reset Workspace Restores the current workspace layout to its default settings.
Reset Window Restores the original window layout.
Layout
List of panes Displays the list of Workbench panes. You can select which panes you want to
display. Any changes you make to panes are carried forward to subsequent
Workbench sessions. For a detailed description of the individual panes listed
here, see Panes within Tabs (p. 455).
Show Connections Displays multiple links connecting systems as a single link where possible. A
Bundled bundled connection includes a label indicating the shared cells (for example, 2-4
indicates that cells 2, 3, and 4 are shared between systems).
Show System Shows the alphanumeric column and row headings for each system. This option
Coordinates is selected by default.

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

Tools Menu
Menu Item Description
Reconnect Reconnects to updates that were pending when the project was closed. This option
is available only if the project has cells in the Pending (p. 465) state. Upon opening a
project, Workbench automatically retrieves the data for any completed background
update.

After reconnecting to pending solution data, it is important to save the project.


For a Solution cell update, if you decline to save the project before exiting, the
intermediate solver data is discarded and is not accessible in future Workbench
sessions. For more information, see Exiting a Project During a Remote Solve
Manager Solution Cell Update (p. 355).
Refresh Project Refreshes all cells in the project (p. 251).
Resume Resumes design point updates that were pending when the project was closed. This
option is available only if the project has design points that are paused due to cells
in a Pending (p. 465) state.
Update All Updates all design points in a project that are in an Update Required (p. 465) state.
Design Points This option is available only when the project contains multiple design points.
Update Project Updates all cells in the project (p. 249) that are in an Update Required (p. 465) state.
Suspend Temporarily suspends or resumes the collection of design point data from Remote
Collecting RSM Solve Manager (RSM)
Results /
Resume These options are enabled when RSM is processing an Update Project or an
Collecting RSM Update All Design Points operation. For more information, see Suspending and
Results Resuming Collection of RSM Design Point Results (p. 369).
Abandon Ignores any results calculated so far and return the project to its normal state.
Pending
Updates Use this option if you have a remote or background solve process (some
component or components in the project were saved in a Pending state) and
attempts to reconnect have failed.

If you use this option, you may need to manually remove processes that were
not stopped or files that were not removed.
Options Defines your user preferences for Workbench. The preferences you set here are local
settings and affect only you. For descriptions, see Workbench User Preferences (p. 433).

Units Menu
Menu Item Description
Display Values as Displays the value and unit as defined in Workbench or the original source
Defined application. No conversion information is displayed.
Display Values in Converts displayed units to correspond to the selected project unit system.
Project Units
Unit Systems Opens the Unit Systems dialog box, where you can choose which unit systems
to display in the Units menu and define custom unit systems. For more
information, see Configuring Units in Workbench (p. 28).

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

Extensions Menu
Menu Items Description
ACT Start Page Opens the ACT Start Page, which provides you with convenient access to ACT
functionality. From this page, you can access multiple tools for both the
development and execution of extensions.
Manage Opens the Extension Manager, which enables you to specify which extensions you
Extensions want to load.
Install Extension Provides for installing a binary extension (WBEX file) into your Application
Data folder so that this extension is available in the Extension Manager.
Build Binary Opens the binary extension builder so that you can compile a binary version of
Extension an extension from the scripted version.
View ACT Console Opens the ACT Console, where you can interactively test commands during the
development or debugging of an extension.
Open App Builder Opens the ACT App Builder, where you can create ACT extensions in a visual
environment.
View Log File Opens the Extensions Log File, which provides messages generated by the
extension. If present, warnings are shown in orange text, and errors are shown in
red text.

Jobs Menu
Menu Item Description
Open Job Monitor Displays the Job Monitor dialog box, which enables you to see the status
of jobs that have been submitted to Remote Solve Manager for the current
project.

For more information, see Monitoring and Controlling Remote Solve


Manager Jobs in Workbench (p. 356).
Open the Design Point Opens a browser window and launches the DPS Web App (p. 375).
Service Web App
Sync with Design Point Synchronizes (p. 378) the Workbench project with the Design Point Service.
Service
Sign out from Distributed Signs you out from Distributed Compute Services (DCS).
Compute Services
Open HPC Job Manager Opens a browser window and launches the Ansys HPC Job Manager Web
App (p. 385).
Sync with HPC Platform Synchronizes (p. 387) the Workbench project with Ansys HPC Platform
Services Services.
Sign out from HPC Signs you out from Ansys HPC Platform Services.
Platform Services
Reset HPC Platform Resets (p. 387) the Ansys HPC Platform Services project ID assigned to the
Services project ID Workbench project.

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

Help Menu
Menu Item Description
Ansys Workbench Help Opens the online help (p. 26).
Show Context Help Opens the Sidebar Help (p. 25) pane.
Installation Help Opens the Ansys, Inc. Installation Guides.
Licensing Help Opens the Licensing Documentation.
Getting Started Opens the Sidebar Help (p. 25) pane to the Getting Started topic.
Ansys Product Opens the Ansys Product Improvement Program (p. 17) dialog box.
Improvement Program
About Ansys Workbench Opens the About Ansys Workbench dialog box containing various
product details.

Context Menus
Context menu options provide capabilities that enable you to work with your existing systems or to
add to and modify projects.

The following types of context menus are available in Workbench:

Common Context Menu Options


In addition to the menu items that are unique to each system or cell, some of the options on the
context-sensitive menu are available with most systems and cells.

Menu Item Description


Edit Opens the cell workspace tab so you can review the data and edit as needed.
Duplicate Creates a new system that is a duplicate of the selected system (p. 242).
Update Refreshes input data and generates required output data (p. 248).
Update Upstream Updates the components upstream of the cell without updating the cell
Components itself (p. 250).
Rename Renames the system or cell.
Refresh Reads in all modified upstream data but does not necessarily regenerate the
outputs of the cell (p. 251).
Quick Help Displays a quick help panel for the cell, if available (p. 24).
Add/Edit Note Displays an editable panel where you can enter notes about a system, cell, or
project (p. 247).
Properties Displays applicable properties in the Properties pane.
Recently Used Lists all recently used files.
Clear Generated Removes or erases any data that the cell has generated or is to generate and
Data store if any such data is present (p. 253).
Reset Removes or erases both input and output data to the cell and sets the cell state
back to the default (p. 254).

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

Transfer Data Context Menu Options


Many cells include transfer data options in their context menu. Transfer data options are available
only from root cells. If a cell is derived from an upstream cell (for example, when two systems share
a geometry), you can transfer data only to/from the originating cell.

Menu Item Description


Transfer Data from Creates an upstream system that can provide data to the selected cell (p. 66).
New
Transfer Data to New Creates a downstream system that can accept data from the selected
cell (p. 66).

Tab Context Menu Options


When you click cells in the Project Schematic, some of them open in separate tabs. The context
menu options available depend on which tabs are open. For example, if only the Project tab is open,
no context options are available. The following context menu options are available for tabs.

Menu Item Description


Close Tab Closes the selected tab. Available for all tabs except for the Project tab.
Close Other Closes all other tabs if accessed from the Project tab. Closes all tabs except for the
Tabs one selected and the Project tab if accessed from another tab.

Available for all tabs when multiple tabs are open.


Close All Closes all tabs (including the selected tab) except for the Project tab. Available for
all tabs except for the Project tab.

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

System Header Context Menu Options


The following options are available from the context menu for system headers.

Menu Item Description


Refresh Refreshes all cells in the selected system (p. 251).
Update Updates all cells in the selected system, along with any cells in upstream systems
that provide data to them (p. 250).
Duplicate Duplicates all cells (p. 242). No data is shared between the two systems. Equivalent
to issuing a duplicate on the first cell of the system.
Replace with Switches the analysis or solver type for an existing system (p. 247).
Delete Deletes the system from the schematic (p. 246).
Recreate Deleted Creates new cells at the points where the previous cells were removed.
Cells
Some cells can be deleted manually (for example the Results cell in a Fluid
Flow system). in some cases, transferring data from one system replaces the
data that was previously consumed from upstream cells in the same system,
and so those upstream cells are deleted.
Rename Renames the system (p. 241).
Properties Displays system properties in the Properties pane.
Add/Edit Note Displays an editable panel where you can enter notes about a system, cell, or
project (p. 247)

Project Schematic Context Menu Options


Right-click in white space in the Project Schematic to select a context menu option for the project.
The options that are visible depend on the specific configuration of the project.

Menu Item Description


Resume Resumes design point updates that were pending when the project was closed. This
option is available only if the project has design points that are paused due to cells
in a Pending (p. 465) state.
Refresh Project Refreshes all cells in the project (p. 251).
Reconnect Reconnects to updates that were pending when the project was closed. This option
is available only if the project has cells in the Pending (p. 465) state. Upon opening
a project, Workbench automatically retrieves the data for any completed background
update.

After reconnecting to pending solution data, it is important to save the project.


For a Solution cell update, if you decline to save the project before exiting, the
intermediate solver data is discarded and is not accessible in future Workbench
sessions. For more information, see Exiting a Project During a Remote Solve
Manager Solution Cell Update (p. 355).
Update All Updates all design points in a project (p. 316) that are in an Update Required (p. 465)
Design Points state. This option is available only when the project contains multiple design points.
Update Project Updates all cells in the project (p. 249) that are in an Update Required (p. 465) state.

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

Menu Item Description


Add to Custom Adds systems to custom template (p. 233).
New system Select a new type of system to add to the project (p. 60).
type...
Show Displays multiple links connecting systems as a single link where possible. A bundled
Connections connection includes a label indicating the shared cells (for example, 2-4 indicates
Bundled that cells 2, 3, and 4 are shared between systems).
Show System Shows the alphanumeric column and row headings for each system. This option is
Coordinates selected by default.
Fit Resizes the systems in the Project Schematic to better fit in the window as it is
currently sized.
Add/Edit Note Displays an editable panel where you can enter notes about a system, cell, or
project (p. 247).

Link Context Menu Options


You can right-click a link to see additional context menu options.

Menu Description
Item
Delete Deletes the selected link (p. 67).
Properties Opens the Properties pane for the link, where you can see the link type, origination cell,
and destination cell.

Note:

To properly update the state of a cell for a linked system, either open the
Mechanical application or click Update Project on the toolbar.

Geometry Context Menu Options


The following options are available from the context menu for a Geometry cell.

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

Menu Item Description


New Geometry (or New Launches DesignModeler or SpaceClaim Direct Modeler, where you can build
DesignModeler a new geometry.
Geometry/New
SpaceClaim Direct
Modeler Geometry)
Import Geometry Opens a dialog box where you can navigate to an existing geometry file or
select a file from the list of recently viewed files.
Edit (or Edit Geometry Opens the model in DesignModeler or SpaceClaim Direct Modeler to modify
in DesignModeler/Edit it.
Geometry in SpaceClaim
Direct Modeler)
Replace Geometry Opens a dialog box where you can navigate to an existing geometry file or
select a file from the list of recently viewed files to replace the currently
specified file.
Update from CAD Generates an existing CAD geometry using the parameter values as defined
in the CAD system.
Refresh Reads in all modified upstream data but does not regenerate the geometry.
Enabled when the Geometry cell is in the Refresh Required state.
Properties Displays a Properties pane where you can select basic and advanced
geometry properties. For property descriptions, see Geometry Preferences.

Setup Context Menu Options


The following options are available from the context menu for a Setup cell.

Menu Description
Item
Edit Launches one of the following options:

• Mechanical application with the geometry loaded and with cells mapped to their
respective tree locations in the Mechanical application.

• CFX-Pre.

Import Imports either an existing Mechanical case file containing physics data, region, and mesh
Case information for your analysis, or an existing Fluent case file.

Solution Context Menu Options


The following options are available from the context menu for a Solution cell.

Menu Item Description


Edit Launches one of the following options:

• Mechanical application open to the solution branch.

• CFX-Pre.

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

Menu Item Description


• Fluent.

Delete Deletes the Solution and Results cell. This changes the system to a setup-only system,
meaning the system generates only an input file. It does not solve or post results. The
solution object and objects below it are removed from the Mechanical application tree.
Import Displays the most recent CFX-Solver results files imported (if any) and specify the
Solution CFX-Solver results file to load in the Open dialog box. When the results file is loaded,
the system displays only the Solution cell and the Results cell.
Display Opens the Ansys CFX-Solver Manager and shows the results of the previous run.
Monitors
Import Final Selects an existing Fluent data set (for example, one solved on an external cluster) into
Data a Solution cell in a Fluent system and immediately start postprocessing in CFD-Post,
without the need to run the minimum of one more solver iteration. This option becomes
available after importing case file into the Setup cell.

Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 477
Release 2024 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
478 of ANSYS, Inc. and its subsidiaries and affiliates.
Glossary
analysis system A template that has all the cells required to complete an analysis
for a particular type of physics, such as static structural.

archive Save all project files and data into a single package that can be
shared, stored, and reused.

cell A part of a system that represents a discrete task in the process of


completing the overall analysis. Typical cells include Engineering
Data, Geometry, Model or Mesh, Setup, Solution, and Results.

component system A system template that has the cells necessary to complete only a
portion of a complete analysis. Often these systems are task-oriented
(for example, a system to create a geometry or to produce a mesh)
or are associated with a particular application.

component update An update of a single component (or cell) within a system in an


Ansys Workbench project. For example, an update of the Analysis
cell within a project is a component update.

A Solution cell update is the only component update currently


supported by Remote Solve Manager.

context menu A context-sensitive list of options available from a cell or other


component, accessed by a right-mouse click.

custom system A system template that has all of systems necessary to complete a
coupled analysis, such as FSI or thermal-stress.

data-integrated applica- An application that has a separate interface from the Ansys Work-
tion bench project window but that still communicates with Ansys
Workbench.

Design Exploration Systems in the Design Exploration group are used to access
DesignXplorer functionality. These systems connect to the Parameter
Set bar in order to drive parametric studies by varying project
parameters.

design point A set of input parameter values and corresponding output parameter
values that make up a single solved instance of a project.

design point update An update of one or more design points in an Ansys Workbench
project. You can update a single design point, a selected set of
design points, or all the design points in a project. During a design
point update, solution data is updated only where output parameters
have been defined.

Design point updates can be submitted to Remote Solve Manager.

downstream In the Project Schematic, data flows from top-to-bottom within sys-
tems and from left-to-right between systems. A cell is said to be

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

downstream if it is below a cell in the same system, or to the right


of a cell in a separate system. Downstream cells use data from up-
stream cells as input.

links Systems in the Project Schematic that are dependent on each other
in some manner are connected with links. Links with a square ter-
minator indicate that data is shared between the two cells connected
by the link, and links with a round terminator indicate that data is
transferred from the upstream to the downstream cell.

parameter A property of a model that can be varied (input parameter) or the


result of varying such a property (output parameter). Custom input
or custom output parameters can be defined by a constant value;
derived parameters are defined by an expression of other parameters
(for example, "P2+3*P3").

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

Project Schematic A region of the Ansys Workbench project window where you will
construct and interact with your project. Projects are represented
as connected systems displayed in a flowchart form that allows en-
gineering intent, data relationships, and the state of the analysis
project to be understood at a glance.

project update An update of an entire Workbench project. All the systems, compon-
ents, and design points in the project are updated.

refresh An action that reads in all modified upstream data but does not
necessarily regenerate the outputs of the cell.

systems A collection of cells that together perform a dedicated task. Types


of systems include analysis systems, component systems, and custom
systems.

Toolbox A region of the Ansys Workbench interface, located on the left side
of the interface, from which you can choose systems or other com-
ponents to add to the project. The Toolbox is context-sensitive,
meaning the options that appear will change based on what is se-
lected elsewhere in the interface.

update An action that updates data in a particular system or cell with any
new information that has been added to the project since the last
update and regenerates the outputs.

upstream In the Project Schematic, data flows from top-to-bottom within


systems and from left-to-right between systems. A cell is said to be
upstream if it is above a cell in the same system or to the left of a
cell in a separate system. Upstream cells provide their output data
to downstream cells.

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

You might also like