Ansys CFX Introduction
Ansys CFX Introduction
Ansys CFX Introduction
ANSYS, Ansys Workbench, AUTODYN, CFX, FLUENT and any and all ANSYS, Inc. brand, product, service and feature
names, logos and slogans are registered trademarks or trademarks of ANSYS, Inc. or its subsidiaries located in the
United States or other countries. ICEM CFD is a trademark used by ANSYS, Inc. under license. CFX is a trademark
of Sony Corporation in Japan. All other brand, product, service and feature names or trademarks are the property
of their respective owners. FLEXlm and FLEXnet are trademarks of Flexera Software LLC.
Disclaimer Notice
THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFID-
ENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products
and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement
that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products
and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions
of that software license agreement.
ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2015 companies.
For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use,
duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc.
software license agreement and FAR 12.212 (for non-DOD licenses).
Third-Party Software
See the legal information in the product help files for the complete Legal Notice for ANSYS proprietary software
and third-party software. If you are unable to access the Legal Notice, contact ANSYS, Inc.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. iii
Introduction
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
iv of ANSYS, Inc. and its subsidiaries and affiliates.
Chapter 1: Computational Fluid Dynamics
Computational Fluid Dynamics (CFD) is a computer-based tool for simulating the behavior of systems
involving fluid flow, heat transfer, and other related physical processes. It works by solving the equations
of fluid flow (in a special form) over a region of interest, with specified (known) conditions on the
boundary of that region.
Recent advances in computing power, together with powerful graphics and interactive 3D manipulation
of models, have made the process of creating a CFD model and analyzing results much less labor in-
tensive, reducing time and, hence, cost. Advanced solvers contain algorithms that enable robust solutions
of the flow field in a reasonable time.
As a result of these factors, Computational Fluid Dynamics is now an established industrial design tool,
helping to reduce design time scales and improve processes throughout the engineering world. CFD
provides a cost-effective and accurate alternative to scale model testing, with variations on the simulation
being performed quickly, offering obvious advantages.
Equations describing other processes, such as combustion, can also be solved in conjunction with the
Navier-Stokes equations. Often, an approximating model is used to derive these additional equations,
turbulence models being a particularly important example.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 5
Computational Fluid Dynamics
There are a number of different solution methods that are used in CFD codes. The most common, and
the one on which CFX is based, is known as the finite volume technique.
In this technique, the region of interest is divided into small sub-regions, called control volumes. The
equations are discretized and solved iteratively for each control volume. As a result, an approximation
of the value of each variable at specific points throughout the domain can be obtained. In this way,
one derives a full picture of the behavior of the flow.
Additional information on the Navier-Stokes equations and other mathematical aspects of the CFX
software suite is available in Basic Solver Capability Theory in the CFX-Solver Theory Guide.
For example, the pressure drop through a component may be considered excessive:
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
6 of ANSYS, Inc. and its subsidiaries and affiliates.
CFD Methodology
The geometry of the region of interest is then defined. If the geometry already exists in CAD, it can be
imported directly. The mesh is then created. After importing the mesh into the preprocessor, other
elements of the simulation including the boundary conditions (inlets, outlets, and so on) and fluid
properties are defined.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 7
Computational Fluid Dynamics
The flow solver is run to produce a file of results that contains the variation of velocity, pressure and
any other variables throughout the region of interest.
The results can be visualized and can provide the engineer an understanding of the behavior of the
fluid throughout the region of interest.
This can lead to design modifications that can be tested by changing the geometry of the CFD model
and seeing the effect.
The process of performing a single CFD simulation is split into four components:
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
8 of ANSYS, Inc. and its subsidiaries and affiliates.
CFD Methodology
2. Creating regions of fluid flow, solid regions and surface boundary names.
This preprocessing stage is now highly automated. In CFX, geometry can be imported from most
major CAD packages using native format, and the mesh of control volumes is generated automatically.
The physical models that are to be included in the simulation are selected. Fluid properties and
boundary conditions are specified.
1. The partial differential equations are integrated over all the control volumes in the region of in-
terest. This is equivalent to applying a basic conservation law (for example, for mass or momentum)
to each control volume.
2. These integral equations are converted to a system of algebraic equations by generating a set
of approximations for the terms in the integral equations.
An iterative approach is required because of the nonlinear nature of the equations, and as the solution
approaches the exact solution, it is said to converge. For each iteration, an error, or residual, is reported
as a measure of the overall conservation of the flow properties.
How close the final solution is to the exact solution depends on a number of factors, including the
size and shape of the control volumes and the size of the final residuals. Complex physical processes,
such as combustion and turbulence, are often modeled using empirical relationships. The approxim-
ations inherent in these models also contribute to differences between the CFD solution and the real
flow.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 9
Computational Fluid Dynamics
The solution process requires no user interaction and is, therefore, usually carried out as a batch
process.
The solver produces a results file that is then passed to the post-processor.
• Visualization of the variation of scalar variables (variables that have only magnitude, not direction,
such as temperature, pressure and speed) through the domain
• Animation
H K Versteeg and W Malalasekera; Longman, 1995. An excellent introduction to the theory of CFD
with well-presented derivations of the equations.
C T Shaw; Prentice Hall, 1992. An introduction to the practical aspects of using CFD.
S V Patankar; Taylor & Francis, 1980. A standard text on the details of numerical methods.
• Mechanics of Fluids
Bernard Massey, Spon Press, 1998. An undergraduate fluid mechanics text book.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
10 of ANSYS, Inc. and its subsidiaries and affiliates.
Further Background Reading
McGraw Hill Professional Publishing, 1997. A superb reference for the physical properties of fluids.
Milton Van Dyke, The Parabolic Press, 1982. Fluid flow phenomena demonstrated in pictures.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 11
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
12 of ANSYS, Inc. and its subsidiaries and affiliates.
Chapter 2: Overview of Ansys CFX
Ansys CFX is a general purpose Computational Fluid Dynamics (CFD) software suite that combines an
advanced solver with powerful preprocessing and postprocessing capabilities. It includes the following
features:
• An intuitive and interactive setup process, using menus and advanced graphics.
• Buoyancy
• Non-Newtonian flows
• Multiphase flows
• Combustion
• Particle tracking.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 13
Overview of Ansys CFX
How to Participate
The program is voluntary. To participate, select Yes when the Product Improvement Program dialog
appears. Only then will collection of data for this product begin.
Data We Collect
The data we collect under the Ansys Product Improvement Program are limited. The types and amounts
of collected data vary from product to product. Typically, the data fall into the categories listed here:
Hardware: Information about the hardware on which the product is running, such as the:
System: Configuration information about the system the product is running on, such as the:
• country code
• time zone
• language used
• time duration
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
14 of ANSYS, Inc. and its subsidiaries and affiliates.
The Ansys Product Improvement Program
Session Actions: Counts of certain user actions during a session, such as the number of:
• project saves
• restarts
• toolbar selections
• number and types of entities used, such as nodes, elements, cells, surfaces, primitives, etc.
• time and frequency domains (static, steady-state, transient, modal, harmonic, etc.)
• the solution controls used, such as convergence criteria, precision settings, and tuning options
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 15
Overview of Ansys CFX
• solver statistics such as the number of equations, number of load steps, number of design points,
etc.
• actual values of material properties, loadings, or any other real-valued user-supplied data
In addition to collecting only anonymous data, we make no record of where we collect data from. We
therefore cannot associate collected data with any specific customer, company, or location.
No, your participation is voluntary. We encourage you to participate, however, as it helps us create
products that will better meet your future needs.
No. You are not enrolled unless you explicitly agree to participate.
3. Does participating in this program put my intellectual property at risk of being collected or discovered
by Ansys?
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
16 of ANSYS, Inc. and its subsidiaries and affiliates.
The Structure of Ansys CFX
Yes, you can stop participating at any time. To do so, select Ansys Product Improvement Program
from the Help menu. A dialog appears and asks if you want to continue participating in the program.
Select No and then click OK. Data will no longer be collected or sent.
No, the data collection does not affect the product performance in any significant way. The amount
of data collected is very small.
The data is collected during each use session of the product. The collected data is sent to a secure
server once per session, when you exit the product.
Not at this time, although we are adding it to more of our products at each release. The program
is available in a product only if this Ansys Product Improvement Program description appears in the
product documentation, as it does here for this product.
8. If I enroll in the program for this product, am I automatically enrolled in the program for the other Ansys
products I use on the same machine?
Yes. Your enrollment choice applies to all Ansys products you use on the same machine. Similarly,
if you end your enrollment in the program for one product, you end your enrollment for all Ansys
products on that machine.
9. How is enrollment in the Product Improvement Program determined if I use Ansys products in a cluster?
In a cluster configuration, the Product Improvement Program enrollment is determined by the host
machine setting.
10. Can I easily opt out of the Product Improvement Program for all clients in my network installation?
c. Change the value from "on" to "off" and save the file.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 17
Overview of Ansys CFX
Ansys CFX File Types (p. 21) show the file types involved in this data flow.
2.2.1. CFX-Pre
The next-generation physics pre-processor, CFX-Pre, is used to define simulations.
Multiple meshes may be imported, allowing each section of complex geometries to use the most
appropriate mesh.
Analyses, which consist of flow physics, boundary conditions, initial values, and solver parameters,
are also specified. A full range of boundary conditions, including inlets, outlets and openings, together
with boundary conditions for heat transfer models and periodicity, are all available in Ansys CFX
through CFX-Pre; for details, see CFX-Pre Basics in the CFX-Pre User's Guide.
Complex simulations are assembled from one or more configurations, each of which combines an
analysis definition with other related tasks such as remeshing. Control over the configuration execution
order and inter-configuration solution dependencies then facilitates the setup of relatively common
simulations, such as those involving the initialization of a transient analysis using results from a steady-
state analysis. Use of multiple configurations and control also facilitates the setup of increasingly
complex simulations of, for example, performance curves for turbo-machines or internal combustion
engines with evolving geometry and physics.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
18 of ANSYS, Inc. and its subsidiaries and affiliates.
The Structure of Ansys CFX
2.2.2. CFX-Solver
CFX-Solver solves all the solution variables for the simulation for the problem specification generated
in CFX-Pre.
One of the most important features of Ansys CFX is its use of a coupled solver, in which all the hydro-
dynamic equations are solved as a single system. The coupled solver is faster than the traditional se-
gregated solver and fewer iterations are required to obtain a converged flow solution.
Additional information on the CFX-Solver models is available; for details, see Basic Capabilities Mod-
eling in the CFX-Solver Modeling Guide.
Additional information on the CFX-Solver Manager is available; for details, see CFX-Solver Manager
Basics in the CFX-Solver Manager User's Guide.
2.2.4. CFD-Post
CFD-Post provides state-of-the-art interactive postprocessing graphics tools to analyze and present
the Ansys CFX simulation results.
• Quantitative post-processing
• Command line, session file, or state file input (see File Types Used and Produced by CFD-Post in
the CFD-Post User's Guide)
• User-defined variables
• Generation of a variety of graphical objects where visibility, transparency, color, and line/face ren-
dering can be controlled (see CFD-Post Insert Menu in the CFD-Post User's Guide)
• Power Syntax to allow fully programmable session files (see Power Syntax in Ansys CFX in the CFX
Reference Guide).
Additional information on CFD-Post is available; for details, see Overview of CFD-Post in the CFD-Post
User's Guide.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 19
Overview of Ansys CFX
This opens the Ansys CFX Launcher, from which all other components of Ansys CFX can be accessed.
You will usually want to start by setting your Working Directory (where all files will be written to) and
then opening CFX-Pre by clicking the CFX-Pre 2022 R1 button. See Using the Ansys CFX Launcher (p. 31)
for more information about using the launcher.
Note:
• You can also start Ansys components from the command line (Starting Ansys CFX Com-
ponents from the Command Line (p. 22)) or Ansys Workbench (Ansys CFX in Ansys
Workbench (p. 33)).
• For CFX, TurboGrid and CFD-Post applications, the graphics viewer, which is based on
OpenGL 4.5, will work with Microsoft Windows Remote Desktop Connection only if you
are using Nvidia Quadro graphics cards with appropriate drivers for Windows 10. If you
see an empty (black) viewer, try setting the environment variable QT_OPENGL=desktop
on the remote machine before starting the application. To work around this issue you may
launch the CFX application prior to making the remote connection, or use one of the
other Ansys-supported remote display methods.
• If you are running CFX-Pre/CFD-Post/TurboGrid on a Linux machine that does not have a
compatible OpenGL driver installed, you can try starting the CFX application with software
rendering enabled by adding the command line parameter: -gr mesa.
The names of objects must be no more than 80 characters in length. Any of the following characters
are allowed to name new objects: A-Z a-z 0-9 <space> (however, the first character must
be A-Z or a-z). Multiple spaces are treated as single space characters, and spaces at the end of
a name are ignored. In general, object names must be unique within the physics setup.
In Ansys CFX, only a period is allowed to be used as a decimal delimiter in fields that accept
floating-point input. Depending on your system configuration, fields that accept numeric input
will either accept a comma but return an error, or not accept a comma at all.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
20 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys CFX File Types
Ansys Workbench accepts commas as decimal delimiters, but translates these to periods when
passing data to Ansys CFX.
Note:
CFX will not function correctly on a Linux system with the environment variable
"LC_ALL" set to a locale which uses a comma delimiter. The environment variable
"LANG" can usually be used to set the locale instead.
UNC paths are not supported in Ansys CFX. You should use drive letters when opening Ansys
CFX products over a network installation.
bin Contains executable programs for starting Ansys CFX software components.
config Contains the host definition file for Ansys CFX software.
etc Contains various data files common to all supported system types.
examples Contains sample files, including C source code files that can be used as the basis
of custom executables. User Fortran examples are also provided.
include Contains header files used by parts of the Ansys CFX software.
lib Contains libraries needed to relink the CFX-Solver for user-defined mesh import
or mesh export.
tools Contains software tools such as cygwin, perl, and qt.
The use of these files with their default extension is shown in the following flowchart. The standard
files used and produced are indicated with solid black lines; other possible uses are indicated with
dotted lines.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 21
Overview of Ansys CFX
• File Types Used and Produced by CFD-Post in the CFD-Post User's Guide
For information on producing files for input into other post-processors, see File Export Utility in the
CFX-Solver Manager User's Guide.
For example, to start up CFX-Pre and play a session file named StaticMixer.pre, open a terminal
window and enter the command:
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
22 of ANSYS, Inc. and its subsidiaries and affiliates.
Starting Ansys CFX Components from the Command Line
where <CFXROOT> is the path to your installation of CFX, for example C:\Program Files\ANSYS
Inc\V221\CFX on Windows.
The following table lists some of the commands you can use to start Ansys CFX components:
cfx5launch
CFX-Pre cfx5pre See Starting CFX-Pre from the Command Line in the
CFX-Pre User's Guide.
CFX-Solver cfx5solve See Starting the CFX-Solver from the Command Line in
Manager the CFX-Solver Manager User's Guide.
CFD-Post cfdpost See Starting CFD-Post from the Command Line in the
CFD-Post User's Guide.
Tip:
• To display a full list of all the possible arguments and a short description for any command,
type the command followed by -help. For example:
cfdpost -help
• Typing the argument -verbose after a command launches the software specified and
displays a summary of the currently set environment variables.
• Ansys CFX Launcher provides a command line with a preset path to the Ansys CFX execut-
ables. From the launcher, select Tools > Command Line. For details, see Command Line.
• You can append the path to the Ansys CFX executables to your Windows PATH.
5. Append the path to the Ansys CFX executables to the Variable value field. For ex-
ample:
6. Click OK as required to set the new path and close the dialog boxes.
• You can append the path to the Ansys CFX executables to your UNIX search path.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 23
Overview of Ansys CFX
Argument Usage
-arch Displays the long architecture string for the current machine.
-cmds Prints the location of some common commands, if they can be found
in the PATH.
-config If any site-specific or user-specific configuration files are in use, this
option will display their locations and contents.
-full Displays a full report on the installation and configuration of Ansys CFX,
suitable for emailing to the Ansys CFX Support desk. This includes the
output of the -inst and -system options.
-help Shows available command line options and descriptions.
-host Displays the current host name.
-host-addr Looks up the named <host> in the network database, and displays some
<host> information about it.
-inst Displays information about the installation directory, and available
versions of Ansys CFX. This is the default if no arguments are passed.
-os Displays the short architecture string for the current machine.
-reltype Displays the release type, which will be "development," "prerelease" or
"release."
-subsets Shows information about which subsets are installed. This option is valid
only for UNIX platforms.
-system Displays information about the system on which Ansys CFX is running.
-verbose Prints information about the environment variables that are currently
set. The alternative form for this argument is -v
-whereis Displays all available versions of <cmd>, as found on the PATH. This
<cmd> option can be repeated.
Note:
Note: The 3D Viewer in CFX/CFD-Post/TurboGrid does not support the buttons of a 3Dcon-
nexion device. However it might be possible to use the software provided with the device
to configure the buttons so that they send key sequences that trigger 3D Viewer actions.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
24 of ANSYS, Inc. and its subsidiaries and affiliates.
Compatibility with File Hosting Services
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 25
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
26 of ANSYS, Inc. and its subsidiaries and affiliates.
Chapter 3: Customizing Ansys CFX
This chapter discusses:
3.1. Ansys CFX Resource Configuration Files
1. <CFXROOT>/config/cfx5rc-<host>.txt
2. <CFXROOT>/config/cfx5rc-<arch>.txt
3. <CFXROOT>/config/cfx5rc-<os>.txt
4. <CFXROOT>/config/cfx5rc.txt
5. <CFXROOT>/config/cfx5rc-site.txt
where:
You can find the value of host, arch, and os by selecting Show > Show System from the menu bar
of the Ansys CFX Launcher. On Windows, the value of os is winnt.
Note:
Any resources set in these files will affect all users of Ansys CFX, unless users override these
variables in their personal user’s Ansys CFX resource configuration files.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 27
Customizing Ansys CFX
• cfx5rc-<host>.txt
• cfx5rc-<arch>.txt
• cfx5rc-<os>.txt
• cfx5rc.txt
(and for the same files without .txt appended) in the following directories:
The right hand side of an assignment may include references to previously assigned variables by
prefixing the variable name with $; for example,
CFX5BROWSER="$CFX5EDITOR"
Note:
In previous releases of Ansys CFX, these files could contain arbitrary Bourne shell commands.
These are no longer supported.
• CFDS_
• CFX_
• CFX4
• CFX5
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
28 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys CFX Resource Configuration Files
• CUE_
You must not set any variable of your own with a name beginning with these letters.
Resource Description
CFX5BROWSER Sets the program to use when browsing files in Ansys CFX.
CFX5BROWSER="xterm -e view"
CFX5EDITOR Sets the program to use when editing files in Ansys CFX.
CFX5EDITOR="xterm -e vi"
CFX5XTERM Creates a window to interact with the operating system.
If set to U, then the files generated will be in binary format, but not
compressed.
If not set, then the files generated will be binary and compressed.
This is the default.
CFX_IMPORT_EXEC Sets the name of the user-defined executable for CFX Volume Mesh
Import.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 29
Customizing Ansys CFX
Resource Description
ANSYSLMD_LI Can be used to identify a license server machine or license file. If set,
CENSE_FILE this specification is used before any other license path information.
See Ansys Client Settings Utility in the Ansys, Inc. Licensing Guide for
precedence information.
Note:
ANSYSLI_SERVERS Used to identify the server machine for the Licensing Interconnect.
Set to port@host. The default port is 2325. This setting takes
precedence over settings specified in the ansyslmd.ini file.
SHLIB_PATH This is a colon-separated list of directories that will be searched to
look for shared libraries on HP systems. If you have installed system
libraries in directories that are not included in this list, then add them
to it.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
30 of ANSYS, Inc. and its subsidiaries and affiliates.
Chapter 4: Using the Ansys CFX Launcher
CFX can be run in two modes:
• CFX stand-alone, which refers to CFX running as a stand-alone application independent of the Ansys
Workbench software
• CFX in Workbench, which refers to CFX running as a component inside of the Ansys Workbench
software. This is described in Ansys CFX in Ansys Workbench (p. 33).
Note:
For CFX, TurboGrid and CFD-Post applications, the graphics viewer, which is based on OpenGL
4.5, will work with Microsoft Windows Remote Desktop Connection only if you are using
Nvidia Quadro graphics cards with appropriate drivers for Windows 10. If you see an empty
(black) viewer, try setting the environment variable QT_OPENGL=desktop on the remote
machine before starting the application. To work around this issue you may launch the CFX
application prior to making the remote connection, or use one of the other Ansys-supported
remote display methods.
Note:
If you are running CFX-Pre/CFD-Post/TurboGrid on a Linux machine that does not have a
compatible OpenGL driver installed, you can try starting the CFX application with software
rendering enabled by adding the command line parameter: -gr mesa.
Ansys CFX stand-alone has the launcher, which makes it easy to run all the modules of CFX without
having to use a command line. The launcher enables you to:
• Access various other tools, including a command window that enables you to run other utilities.
The launcher automatically searches for installations of CFX and Ansys products including the license
manager. Depending on the application, the search includes common installation directories, directories
pointed to by environment variables associated with CFX and Ansys products, and the Windows registry.
In the unlikely event that a product is not found, you can configure the launcher using steps outlined
in Customizing the Ansys CFX Launcher in the CFX Reference Guide.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 31
Using the Ansys CFX Launcher
This chapter discusses Starting the Ansys CFX Launcher (p. 32). For more information about the
launcher, see Ansys CFX Launcher in the CFX Reference Guide.
• On Windows:
– From the Start menu, select Ansys 2022 R1 > CFX 2022 R1.
– In a Command Prompt that has its path set up correctly to run Ansys CFX, enter: cfx5
If the path has not been set, you need to type the full path to the cfx5 command; typically this
is:
C:\Program Files\ANSYS Inc\V221\CFX\bin\cfx5.exe
• On Linux, open a terminal window that has its path set up to run Ansys CFX and enter: cfx5
If the path has not been set, you need to type the full path to the cfx5 command; typically this is:
/usr/ansys_inc/v221/CFX/bin/cfx5.exe
Note:
When you start Ansys CFX Launcher, the displayed Working Directory is not the directory
the launcher was started in; the directory is defined by the settings stored in CFXPrefer-
ences.ccl. To default the working directory to the current directory at start-up, set the
CFX_LAUNCH_START_IN_CWD environment variable to 1.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
32 of ANSYS, Inc. and its subsidiaries and affiliates.
Chapter 5: Ansys CFX in Ansys Workbench
Ansys CFX components can be run in two modes:
• As stand-alone applications started from the Ansys CFX Launcher and independent of the Ansys
Workbench software. This mode is described in Using the Ansys CFX Launcher (p. 31).
Note:
For CFX, TurboGrid and CFD-Post applications, the graphics viewer, which is based on OpenGL
4.5, will work with Microsoft Windows Remote Desktop Connection only if you are using
Nvidia Quadro graphics cards with appropriate drivers for Windows 10. If you see an empty
(black) viewer, try setting the environment variable QT_OPENGL=desktop on the remote
machine before starting the application. To work around this issue you may launch the CFX
application prior to making the remote connection, or use one of the other Ansys-supported
remote display methods.
Note:
This chapter assumes that you are familiar with using Ansys CFX in stand-alone mode. You
should consult the Ansys Workbench help for more detailed information on Ansys Workbench.
Important:
CFX in Ansys Workbench does not support the use of filenames or project names that contain
multiple consecutive spaces, or the "$", "#", or "," characters anywhere in their filepath.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 33
Ansys CFX in Ansys Workbench
To launch Ansys Workbench on Linux, open a command line interface, type the path to "runwb2" (for
example, "~/ansys_inc/v221/Framework/bin/Linux64/runwb2"), then press Enter.
The Ansys Workbench interface is organized to make it easy to choose a system (a group of components)
that will enable you to solve particular types of problems. Once you have chosen a system from the
Toolbox and moved it into the Project Schematic, supporting features such as Properties and Messages
provide orienting information. These features and the status indicators in the system cells guide you
through the completion of the System steps.
The figure that follows shows Ansys Workbench with a TurboGrid component system and a Fluid Flow
(CFX) analysis system open and linked together. The properties of cell A1 (TurboGrid) are displayed in
the Properties pane:
5.1.1. Toolbox
The Toolbox shows the systems available to you:
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
34 of ANSYS, Inc. and its subsidiaries and affiliates.
The Ansys Workbench Interface
Analysis Systems
Systems that match the workflow required to solve particular types of problems. For example,
the Fluid Flow (CFX) system contains tools for creating the geometry, performing the meshing,
setting up the solver, using the solver to derive the solution, and viewing the results.
Component Systems
Software elements upon which Analysis Systems are based. For example, the CFX component
system contains Setup (CFX-Pre), Solution (CFX-Solver Manager), and Results (CFD-Post). The
Results component system contains only Results (CFD-Post).
Custom Systems
Systems that combine separate analysis systems. For example, the FSI: Fluid Flow (CFX) > Static
Structural system combines Ansys CFX and the Mechanical application to perform a unidirectional
(that is, one-way) Fluid Structure Interaction (FSI) analysis.
Design Exploration
Systems that enable you to see parametric change of outputs in relation to changing inputs.
Note:
Which systems are shown in the Toolbox depends on the licenses that exist on your system.
You can hide systems by enabling View > Toolbox Customization and clearing the check
box beside the name of the system you want to hide.
When you move a system from the Analysis Systems toolbox to the Project Schematic, you will see
a set of tools similar to the following:
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 35
Ansys CFX in Ansys Workbench
Each white cell represents a step in solving a problem. Right-click the cell to see what options are
available for you to complete a step.
Many cells launch specialized software that enables you to perform the task required by that step.
For example, in a Fluid Flow (CFX) system:
However, the system cells are not simply launching other software, they operate to advance the
workflow. For example, if the Mesh cell is in the state Update required, you will not be able to launch
CFX-Pre from the Setup cell until the Mesh cell has been updated.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
36 of ANSYS, Inc. and its subsidiaries and affiliates.
The Ansys Workbench Interface
To display the Properties for a particular cell, right-click the cell and select Properties. Once the
Properties pane is open, simply selecting a cell in the Project Schematic will display that cell's
properties.
The default, which applies to newly created systems, can be changed via
a Workbench preference. For details, see CFX in the Workbench User's
Guide.
Choose False to retain old solution data when updating the Solution
cell. This is the behavior for Release 16.2 and prior releases.
The default, which applies to newly created systems, can be changed via
a Workbench preference. For details, see CFX in the Workbench User's
Guide.
Cache Solution Data Choose True to retain cached solution data for non-current Design Points
(in addition to the current Design Point) after they are solved. This allows
for faster Design Point restarts, and is especially useful when updating
multiple Design Points after making a small non-parametric change to
the case; the cached solution data is used to provide initial conditions.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 37
Ansys CFX in Ansys Workbench
The default can be changed via a Workbench preference. For details, see
CFX in the Workbench User's Guide.
Note:
Choose False (the default, unless you change the Workbench preference
for this property) to automatically, after solving the current Design Point,
delete any associated cached solution data (in effect, performing Clear
Cached Solution Data > Current Design Point Only). This is useful for
reducing the total disk space used by the project.
Note that, for this choice (False), solving all Design Points has the effect
of deleting the associated cached solution data for all Design Points.
The default can be changed via a Workbench preference. For details, see
CFX in the Workbench User's Guide.
Initialization Option Automatic
[a] [b]
This option is intended to use the best available solution data to initialize
the solution.
The data for initializing the solution is found according to the following
order of precedence:
1. Restart
5. Initial conditions
Note:
The data for initializing the solution is found according to the following
order of precedence:
• Restart
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
38 of ANSYS, Inc. and its subsidiaries and affiliates.
The Ansys Workbench Interface
• Initial conditions
Note:
The data for initializing the solution is found according to the following
order of precedence:
1. Restart
4. Initial conditions
Note:
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 39
Ansys CFX in Ansys Workbench
The data for initializing the solution is found according to the following
order of precedence:
• Restart
• Initial conditions
Note:
Execution Control If you add or change Execution Control in CFX-Pre in a way that is
Conflict Option perceived to conflict with the Execution Control settings stored in the
Solution cell, by default an error message appears when you attempt to
update the Solution cell. From the Properties pane you can choose to set
Workbench to:
• Warn
This is the default (unless you change the Workbench preference for
this property), which enables you to decide on a case-by-case basis by
using the Solution cell's context menu.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
40 of ANSYS, Inc. and its subsidiaries and affiliates.
The Ansys Workbench Interface
The default can be changed via a Workbench preference. For details, see
CFX in the Workbench User's Guide.
Note:
• Run in Background
• Run in Foreground
• During a foreground update, the user interface strictly limits what you
can do. For example, you cannot edit other cells, save, or quit.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 41
Ansys CFX in Ansys Workbench
After saving and quitting, the solver run will still continue. You can
re-open the project and use the Reconnect button to access data that
was put into batch mode.
Note:
The run mode for the update to the Solution cell is set on
the CFX-Solver Manager's Define Run dialog box. If you
specify a remote host, you must ensure that the run mode
you choose is supported on that host.
For a project that has been saved, a foreground update that is in progress
can be made into a background update by using the Switch Active
Solution to Background context menu option. This action will not change
the Update Option setting for the next run.
Results Cell Properties
Generate Report Select this check box to automatically publish a report. The location of
the report is displayed in the Files pane.
[a] When running in Workbench, CFX-Solver Manager has, in its Define Run dialog box, on
the Initial Values tab, an Initialization Option setting that synchronizes interactively with
changes in the Initialization Option property of the Solution cell. For details on the Initial
Values tab, see Initial Values Tab in the CFX-Solver Manager User's Guide.
[b] For cases involving System Coupling, and for cases involving multiple configurations, this
property must be set to Update from initial conditions.
[c] For details, see Configurations in the CFX-Pre User's Guide.
Important:
Although the Files pane reveals the data files that make up a project, you should not at-
tempt to manipulate these files directly, as project data management will proceed unaware
of your changes and with unpredictable results.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
42 of ANSYS, Inc. and its subsidiaries and affiliates.
The Ansys Workbench Interface
they appear in the Files pane. This pane can be used to identify which files are associated with
each cell.
The table that follows associates cell types with file types and gives typical extensions for those file
types.
Report.html[a]
[a] Generated file (Generated files are not copied when you duplicate a system and are removed
when you run the Clear Generated Data command.)
[b] Does not include animation files or the output of Save Picture commands.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 43
Ansys CFX in Ansys Workbench
When you import a mesh file into CFX-Pre from a Fluid Flow (CFX) system and no geometry or
mesh exists in the upstream cells, the Mesh and Geometry cells are automatically deleted. You
can restore these cells by right-clicking the system header and selecting Recreate Deleted Cells.
There are also commands that are specific to CFX Solution cells:
Display Monitors
Opens the CFX-Solver Manager and shows either the monitors of the run in progress or, if there
is no run in progress, the results of the latest solver run associated with the cell.
If you are monitoring the progress of a Remote Solve Manager run, by default the progress reports
update every 30 seconds. However, you can adjust this through the Progress Download Interval
setting in the Solution cell Properties. See Submitting Solutions to Remote Solve Manager in the
Workbench User's Guide for details.
Note:
If running using RSM you cannot use the CFX-Solver Manager to edit, interrupt, or stop
the run in progress, or to trigger a manual backup file.
Import Solution
Displays the most recent CFX Solver Results files imported (if any) and enables you to browse for
such files using the Open dialog box, where you can specify the CFX Solver Results file to load.
When the results file is loaded, the system will display only the Solution cell and the Results cell.
Continue Calculation
Performs an update of the Solution cell, completing a previously stopped run (if one is available),
or otherwise restarts the current run.
When you start a solver run or when you click Save Settings on the Define Run dialog box of
the CFX-Solver Manager, the settings from the Define Run dialog box are stored for the Solution
cell that launched the solver. These are the execution control settings for that cell; the Clear Exe-
cution Control command removes those settings.
Note:
You should not clear the execution control settings while the CFX-Solver Manager is
running as this can make file paths in the Define Run dialog box inaccurate.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
44 of ANSYS, Inc. and its subsidiaries and affiliates.
Data Flow Within and Between Systems
Enables you to reduce the use of disk space. There are two options:
Deletes all the results files except the most recent one and any results files to which it refers.
Deletes all the results files except the most recent one.
Note that there is no change to cache data for any Design Point.
Enables you to reduce the use of disk space. There are two options:
Deletes the associated cached solution data for the current Design Point, but not for the non-
current Design Points.
Deletes the associated cached solution data for all Design Points in the project.
Similarly, the same type of data flow occurs between systems. For example, if you have an FSI: Fluid
Flow system (as shown in the image below), data and status from the Fluid Flow (CFX) Geometry cell
will flow both to the Fluid Flow (CFX) Mesh cell and the Static Structural Geometry cell. Data flow
between systems is shown by interconnecting lines:
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 45
Ansys CFX in Ansys Workbench
The data flow between cells (and systems) drives the workflow.
1. You begin by launching Ansys Workbench, which opens as an unsaved project and displays the
available Analysis Systems.
2. In your file system you create a directory in which to store your project files. You then select File
> Save As and save your new project to that directory. This automatically sets your working directory
for this project.
3. In the Analysis Systems toolbox, double-click Fluid Flow (CFX) to create a fluid-analysis system
in the Project Schematic. (Notice that if you "hover" over systems in the Toolbox, a tooltip appears.)
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
46 of ANSYS, Inc. and its subsidiaries and affiliates.
An Example Fluid Flow Setup
The fluid-analysis system in the Project Schematic shows the steps in performing a fluid analysis:
4. In addition to showing those steps in appropriately named cells, each cell can launch a tool that
will enable you to perform the task it names. Right-click the Geometry cell to see your options for
adding a geometry to your project:
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 47
Ansys CFX in Ansys Workbench
5. As you move through the cells from Geometry to Results, you can choose to launch the tool that
will enable you to complete the cell's step:
d. Run the solver by updating the Solution cell, or optionally edit the Solution cell and use the
Define Run dialog box from CFX-Solver Manager.
Note:
The Custom Solver Options (Custom Executable and Solver Arguments), which
are available in the CFX-Solver Manager in stand-alone mode, are not available in
CFX-Solver Manager launched from Ansys Workbench.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
48 of ANSYS, Inc. and its subsidiaries and affiliates.
Default File Locations
Note:
You could open a Fluid Flow (CFX) system and go immediately to the Setup cell to import
an existing case. When the case is loaded, the now-unnecessary Geometry and Mesh
cells disappear.
6. When the analysis is complete and the project is finished, you save the project (and therefore the
associated files). Once a project has been saved, it can be re-opened at a later date for review or
modification of any aspect of the simulation.
Important:
Saving a project enables you to re-open the project on the machine that originally created
it. To make the project available on another machine, you need to use File > Archive to
create a project archive. To open the project on a different machine, run File > Restore
Archive on that machine.
• Save operations default to the user_files directory. The user_files directory appears under
the directory that holds the Project file (<projectfile_name>/user_files/).
If the default directory has already been set, changing the save location in a file dialog box also
changes the default save directory. If a change is made to the project directory through Ansys
Workbench, that will also reset the default directory.
Note:
A change in defaults is held only for the duration of the Ansys CFX application session
(that is, an exit and re-edit of an Ansys CFX application) will reset the defaults back to
project user_files for export operations and to the permanent files directory for import
operations.
• Open operations default to the permanent files directory. The permanent files directory holds the
Project file.
• Export operations initially default to the user_files directory, but change to the last directory
used for an export operation during a session.
In addition, there is an icon in the directory tree that takes you to the user_files, and all recent
directory selections are available from the directory path drop-down selector.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 49
Ansys CFX in Ansys Workbench
Note:
If you select a language other than English under Regional and Language Options,
use of Symmetry and Enclosure operations in DesignModeler can lead to non-ASCII
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
50 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with CFX in Workbench
characters, which are not supported by Ansys CFX, being included in automatically
generated named selections. You can prevent such named selections from being created
by either:
• Using Meshing as part of a Fluid Flow (CFX) system (rather than a separate
Mesh component system), or
• Changing, under the Geometry cell properties, Advanced Geometry Options >
Enclosure and Symmetry Processing to No.
During a refresh of upstream mesh data, CFX-Pre will require that the same series of mesh modific-
ations and transformations on the new mesh be successfully reapplied. If any of these transformations
fail (possibly due to topological changes, or changes to regions and named selections that the
transformations operate on), CFX-Pre will issue an error message, and revert to the previous mesh
data. Workbench will report the error as an "Application Error" during the mesh refresh, however
the Project Schematic state for the Setup cell will indicate that the refresh was done successfully
by being marked as Up-to-date.
To correct this mesh refresh error, the geometry or mesh changes that caused the error should be
reverted, or (if possible) the Mesh cell should be disconnected and the Setup cell refreshed again
before reconnecting the Mesh cell.
It is not possible to read a mesh file without any reference to a geometry file, even when you select
File > Import and select a .cmdb file. A Mesh system that includes a Geometry cell appears (the
Geometry cell has a green tick and a red circle with "!"). If you try to link or duplicate such a system,
problems are observed.
It is also not possible to read a mesh file without any reference to a geometry file when creating
a mesh component system first – you cannot right-click the Mesh cell and select a command to
import a .cmdb file; only .gtm and .cfx files are possible choices.
Connections between systems in Ansys Workbench are direction-dependent. This has implications
in one-way and two-way FSI cases. For example, in a one-way case you need to transfer the data
from the CFX system to the Static Structural system. As a consequence, the CFX system will be
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 51
Ansys CFX in Ansys Workbench
positioned to the left of the Static Structural system on the schematic. For two-way FSI, the Static
Structural system will be positioned to the left of the CFX system on the schematic.
Connections are not supported from the Setup cells of Steady-State and Transient Thermal analyses
systems to the Setup cell of the Fluid Flow systems (for example, thermal two-way FSI).
Using multi-configuration CFX cases as part of a one-way FSI calculation is not supported. The
Project Schematic will permit the connection, but the calculation will fail.
The undo stack is cleared in CFX-Pre/CFD-Post after the application receives commands from Ansys
Workbench.
You cannot launch Ansys CFX products from one another in Ansys Workbench; you must use the
system cells.
Ansys Workbench "remembers" previous locations of imported files / projects. Ansys CFX, however,
displays different behavior for loading or saving any files, always using the directory specified in
the Tools > Options > Default Folder for Permanent Files in Ansys Workbench.
Duplicate node removal for importing Fluent meshes into CFX-Pre is always ON in Ansys Workbench,
regardless of any settings in the Ansys CFX preferences file. CFX-Pre does not read this file when
run in Ansys Workbench.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
52 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with CFX in Workbench
If you create a set up by duplicating an existing one, the run files associated with the first schem-
atic are named according to the name of the schematic; in this release it is not possible to control
the name of the run files in the duplicate schematics.
Duplication normally involves only user files (files for which you have specified settings). For Ansys
CFX, these are the .cfx and .cst files. Other files, which are considered to be "generated" (for
instance, the .def, .res, and .out files), are not duplicated.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 53
Ansys CFX in Ansys Workbench
If you make changes to the execution control in CFX-Pre while you have CFX-Solver Manager open,
you need to click the Refresh button on the Define Run dialog box in order to make sure that the
CFX-Solver Manager re-reads the new information from the CFX-Solver Input file.
Note:
Ansys Workbench supports only one connection from Static Structural or Transient
Structural systems' Setup cells to a single CFX or Fluid Flow (CFX) Setup cell for two-way
FSI.
Always check that the Initialization Option property is set correctly for each Solution cell in any
CFX-related system. This can be viewed and set using:
When running in Workbench, CFX-Solver Manager has, in its Define Run dialog box, on the Initial
Values tab, an Initialization Option setting that synchronizes interactively with changes in the
Initialization Option property of the Solution cell.
The default value for the Initialization Option property is Update from current solution
data if possible unless you change the Workbench preference for this property. Details of
the Initialization Option property are given in Properties Pane (p. 37).
• If you have performed a solver run and want to re-run it with initialization provided by the results
of the first solver run, then you can leave the Initialization Option property set to Update
from current solution data if possible.
• If you have performed a solver run and want to re-run it with the original initialization then perform
at least one of the following actions before re-running:
• If you have performed a solver run and want to re-run it with specified initialization then perform
all of the following actions before re-running:
Clearing the generated data prevents the Solution cell from being in an up-to-date state or in
an interrupted state, thereby preventing restart data from being used.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
54 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with CFX in Workbench
After running the CFX solver multiple times within the same system, for example when updating
the solution or continuing the calculation, you may accumulate unwanted results files from the
previous runs. Consider using Reset or Clear Generated Data on the Solution cell before re-running
the CFX-Solver on this cell. These delete all the files from any previous run on that cell (for example,
all CFX-Solver Results and CFX-Solver Output files), and prevent the project from getting too large.
If you do not want to clear all the files, but want to clear some of them, consider using Clear Old
Solution Data or Clear Cached Solution Data on the Solution cell. If you want to delete specific
files:
2. Sort the list by Cell ID (which is actually the cell coordinates, not the ID).
3. Scroll down to the results file(s) for the desired Solution cell ID.
Note that you cannot directly delete the files from this pane.
This opens your operating system's file browser at the directory containing the result file.
After doing this, you may want to remove the obsolete file references from the list in the Files pane.
Multi-select all the red files (sort by ascending size to get them all together) and choose to Remove
<file> from List to get Ansys Workbench to remove them from the Files pane completely.
If you set the CFX-Solver to Background mode and shut down Ansys Workbench, upon restarting
Ansys Workbench and reopening the project, if the solver run has not completed, you will need to
use the Reconnect button to continue monitoring the solver run.
The information at end of a CFX-Solver Output file shows only the temporary location for the CFX-
Solver Results file, not the final location. The correct locations can be found in the Files pane.
CFX-Solver Results files (in particular the .res files) are associated with the Solution cell, not the
Results cell. This means that a CFX-Solver Results file cannot be imported onto a Results cell; it can
be imported onto a Solution cell of a Fluid Flow or CFX system. Similarly, resetting the Results cell
will not remove the CFX-Solver Results file.
Ansys Workbench permits you to import data from a Polyflow Solution cell into the Solution cell
of a CFX system; however, the CFX-Solver execution will fail when the Solution cell of the CFX system
is updated.
For simulations involving multiple configurations, initializing a Solution cell of either a Fluid Flow
(CFX) analysis system or a CFX component system from another Solution cell is not supported. At-
tempts to update the downstream Solution cell will result in an error. You must define initialization
conditions for each configuration manually.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 55
Ansys CFX in Ansys Workbench
To perform a file comparison in CFD-Post, drag a Solution cell from another system to the Results
cell.
You can have CFD-Post generate report output at every update (by setting Generate Reports in
Results cell Properties pane). The .html file is visible in the Files pane: right-click it, select Open
containing folder, and double-click the file in the explorer to see the report in a browser.
When updating existing Results cell data (with CFD-Post open) where a turbo chart with an averaged
variable was used (for example, turbo reports), a warning dialog box may appear reporting that
"No data exists for variable …" This warning can be ignored.
You can change the CFD-Post multi-configuration load options (available on the Load Results
panel of CFD-Post when in stand-alone mode) by editing the Properties of the Solution cell. This
is a property of the Solution cell, rather than the Results cell.
5.5.2.9. Backwards Compatibility When Ansys CFX Files Exist in the Original
Project
When importing a .wbdb file (that contains .agdb, .cmdb, .cfx, and .res files), only a Mesh
system is imported instead of a "Fluid Flow (CFX)" analysis system. You need to drag a CFX system
and associate the files with this system.
Pointers to the original CFX files are present in the Files pane. Using the right-click option Import
Onto Schematic, a copy of the file is taken and an associated system is generated with the copy
- however the Files pane now seems to have two versions of the same file.
You can drag a CFX system and associate the files with this system, manually importing the file into
the correct cell.
Ansys Workbench does not support directly importing legacy FSI cases, so you have to create a
CFX system from the legacy CFX-Solver Results file, manually link it to the Static Structural system,
suppress the old load in Static Structural, and update it to import the load in the proper format
from the CFX system.
Files that are moved or deleted and that were previously associated with a cell in the Project
Schematic will be highlighted in red in the Files pane. There are right-click options to Remove or
Repair the files. You should be aware that Ansys Workbench will ensure that the file is repaired
using a file of a similar type but not necessarily the same name (or contents). If the contents of the
repaired file do not match those of the original file, unexpected results may be produced or the
case will fail.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
56 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with CFX in Workbench
You can apply a DesignXplorer study to a converged project by opening the project in Ansys Work-
bench and double-clicking a Design Exploration system from the left pane. This displays the design
exploration system under the Parameter Set bar in the Project Schematic.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 57
Ansys CFX in Ansys Workbench
Note:
• A sample tutorial describing how to use design exploration in Ansys CFX is available.
• For more information on using design exploration in Ansys Workbench, see DesignXplorer
User's Guide.
The following sections contain tips for the use of parameters and design exploration:
5.5.3.1. Retaining and Exporting Design Points
5.5.3.2. Number of Design Points
5.5.3.3. Obtaining Solutions for Design Points
5.5.3.4.The CFX-Solver Background Mode
5.5.3.5. Limitations When Using Parameters and Design Points with Ansys CFX
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
58 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with CFX in Workbench
For information on accessing data associated with non-current Design Points, see Retaining Design
Point Data and Exporting Design Points to New Projects in the Workbench User's Guide.
When working with exported Design Points, you should limit the Project Schematic only to systems
that are involved in the Design Point changes. Having other systems (for example, a CFX system)
in the project that are not involved in the Design Point update will mean duplication of these sys-
tems' database/results files for every exported Design Point, and this can use a significant amount
of disk space.
If you generate a large number of Design Points in a Design of Experiments (DOE), it is possible
that a small proportion of them will fail to update, preventing the DOE cell from becoming up-to-
date. In such a case, you cannot continue with the rest of this design exploration analysis. The DOE
can be modified to remove these failing Design Points by selecting Design of Experiments > Type
> Custom and then manually deleting the Design Points that failed to update successfully. Provided
that sufficient Design Points remain for adequate analysis, then the DOE can be updated and you
can continue with the analysis
If you have selected the solution to Update from Current Solution Data (default setting), you may
need to choose the input parameter values wisely for the Current Design Point because it will be
the starting solution for all other Design Points. To avoid this situation, set Update from Initial
Conditions as an Initialization Option in the CFX-Solver Manager before updating the Design
Points.
In a Design Points study, if you have set the CFX-Solver to Background mode[1], none of the Design
Points will become up-to-date until all the solver jobs have finished. This is not the case when the
CFX-Solver has been set to Foreground mode (the default setting), where each Design Point becomes
[1] Note that an adequate number of licenses are required for this.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 59
Ansys CFX in Ansys Workbench
up-to-date before the next one commences updating. The former option, though, can prove more
efficient in terms of speed, especially in the case of long runs on multi-core configurations.
Note:
When the Licensing Interconnect sharing mode is used, the Update of Design Points in
background mode will not work.
5.5.3.5. Limitations When Using Parameters and Design Points with Ansys CFX
• Although the names of design parameters can be modified using the Parameter Manager within
Ansys Workbench, this is not recommended, because the new names will not be reflected within
the CFX application user interfaces.
• In a design points study, when you have some up-to-date design points, you should avoid editing
the Results cell and running CFD-Post interactively. Most editing and viewing actions result in
an underlying state change and therefore make the design points appear out-of-date, requiring
another update.
• If an input parameter is defined in CFX-Pre directly in the physics setup (that is, not using an
expression) then it should be removed by clearing the parameterization check box next to the
parameter setting before any physics changes are made that would make the parameter not
applicable. If it is not removed, then any attempt to change the value of this parameter through
Workbench, or run multiple design points, will result in a physics error of the form: "The
parameter <parameter name> is present in the object <path> but it
is not physically valid.", referring to the parameter that was set as a Workbench input
parameter. If this occurs, then one way to remove the input parameter is to enter the following
into the Command Editor: delete /PARAMETERIZATION/INPUT FIELD: <parameter
name> where <parameter name> is the input parameter name. Once the parameterization
has been removed, the new physics settings can be re-applied in CFX-Pre to remove the physics
error and allow the design point update to complete successfully.
• When running a design point study, the User Location Regeneration setting is effectively set
to All, meaning that all parameterized user locations are updated for each design point. For
details, see Solver Tab in the CFX-Pre User's Guide.
CFX Distributed Parallel is supported via RSM for batch queuing systems.
Remote Solve Manager generally enables you to solve on remote machines as many types of runs as
can be solved on your local machine, but with various restrictions that are generally related to the
availability of external files (files that you have manually specified for certain features in CFX applica-
tions) on the remote machine. For remote runs, where external files may not be available using the
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
60 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with CFX in Workbench
same path as the machine on which the run was set up, RSM has to identify the location of any ex-
ternal files and then copy them to the remote location. Not all external files can be treated correctly
at the current release. The restrictions include:
• Solver models that include user-defined remeshing may not be reliably run in RSM mode if the
External Command refers to a command that is not available in the same location as that specified
in the External Command parameter.
– Custom Solvers
– User-defined remeshing
– Manual specification of Initial Values files (not set up through the Workbench Project Schematic)
– Files referenced from within another non-CFX file (for example, a file referenced by an Ansys Input
File)
Some unsupported features may work if the file paths for external files on the remote machine are
the same as on the machine that set up the case.
To learn how to configure Remote Solve Manager, see Getting Started with Distributed Compute
Gateway in the Distributed Compute Gateway User's Guide.
1. Start Workbench.
2. Drag either a CFX or a Fluid Flow (CFX) system into the Project Schematic.
4. Select View > Properties on the Solution cell to set the following Solution Process options:
b. Set Solve Manager from the drop-down menu. (The available hosts are determined by
the queue.)
c. Set Queue to a queue listed in the drop-down menu. (Use Remote Solve Manager to add
queues and Compute Servers.)
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 61
Ansys CFX in Ansys Workbench
• Intel MPI Local Parallel is supported on all platforms that support RSM, and therefore
is the safest choice.
• Distributed parallel processing is supported only when the RSM Client is also the RSM
Manager and acts as one of the Compute Servers (remote machines can also act as
Compute Servers in this configuration).
5. Update the Solution cell. A dialog box appears that gives the status of the update.
5.5.4.2. Limitations When Using Remote Solve Manager with Ansys CFX
Ansys CFX has the following limitations when used with Remote Solve Manager:
• You cannot edit, interrupt, or stop a run that is in progress using the CFX-Solver Manager. You
can, however, interrupt the run using the Workbench progress bar.
• You cannot create a manual backup file using the Backup button in the CFX-Solver Manager.
• By default the CFX-Solver Manager will update its monitors only every 30 seconds, rather than
continuously. However, you can adjust this through the Progress Download Interval setting in
the Solution cell Properties. See Submitting Solutions to Remote Solve Manager in the Workbench
User's Guide for details.
• Using the Cache Solution Data option in conjunction with the Remote Solve Manager may result
in a large number of data files (all the cached data) being submitted to the Remote Solve Manager
when each design point is calculated. This can lead to a significant slowdown in the overall cal-
culation.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
62 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with CFX in Workbench
Scripting refers to the processes of editing and running a journal file in Workbench. With scripting,
you could, for example, implement a prescribed workflow.
This section describes how to acquire, edit, and run script files that have commands that affect CFX
components. For more general information, see Using Journals and Scripts in the Workbench User's
Guide.
Note:
• Journal actions such as a CFD-Post Export or the loading of a static .res file record the
path of the file. You may need to manually adjust this filepath before attempting to rerun
the journal, particularly if you have created the journal using an unsaved project. More
generally, when you create a project, you should save the project immediately to set
file paths that Workbench uses (rather than require Workbench to use file paths that
have temporary directories, as happens before the project is saved).
• The handling of file paths described in File Path Handling in Ansys Workbench in the
Workbench Scripting Guide applies to file references that are made outside of CCL and
command actions.
• Journal files must not contain an Undo command from a CFX application.
1. Start Workbench.
2. Save the project. (This enables Workbench to set file paths that will be usable when you play
back journal operations that involve the loading or exporting of files.)
3. Start journaling: Select File > Scripting > Record Journal and set a name for the journal file.
4. From Toolbox panel, open a CFX system (such as Component System > CFX).
5. Create and run a CFX simulation. The actions you perform are captured by the Journaling
process and written to the .wbjn file that you named in step 2.
8. Run File > Scripting > Run Script File and select a .wbjn file.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 63
Ansys CFX in Ansys Workbench
Note:
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
64 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with CFX in Workbench
Quit CFX-Pre
setup1.Exit()
In the above snippets, note how CCL and command actions for CFX-Pre are encapsulated as ar-
guments of SendCommand instructions.
Edit the Results cell and load the Results file (StaticMixer_001.res)
results1 = system1.GetContainer(ComponentName="Results")
results1.Edit()
results1.SendCommand(Command=r"""DATA READER:
Clear All Objects = false
Append Results = true
Edit Case Names = false
Open to Compare = false
Multi Configuration File Load Option = Separate Cases
Open in New View = true
Keep Camera Position = true
Load Particle Tracks = true
Files to Compare =
END
DATA READER:
Domains to Load=
END
> load filename=C:\StaticMixer_001.res, multifile=append""")
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 65
Ansys CFX in Ansys Workbench
Set the camera and define a plane colored with a constant color
results1.SendCommand(Command="""VIEW:View 1
Camera Mode = User Specified
CAMERA:
Option = Pivot Point and Quaternion
Pivot Point = 0, 0, 0
Scale = 0.226146
Pan = 0, 0
Rotation Quaternion = 0.279848, -0.364705, -0.115917, 0.880476
Send To Viewer = False
END
END
# ...
# (Lines omitted for brevity)
# ...
END""")
The commands in the script above are the default values for a plane.
5.5.5.2.1. Example: Using a Script to Change the Turbulence Setting in a Setup Cell
If you have a Workbench project currently open, you can run a script to change the characteristics
of the simulation. For example, if you have edited a Setup cell from a Workbench system, loaded
a case with a Default Domain in Flow Analysis 1, and want to use an interactive script
to set CFX-Pre to use one of two turbulence settings, you can run a script similar to the one that
follows.
Before running this script, you would have to first open the Command Window dialog box (by
selecting File > Scripting > Open Command Window from the Workbench main menu). To run
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
66 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with CFX in Workbench
the script, you would select File > Scripting > Run Script File from the Workbench main menu
and then use the browser to open the file containing the script.
x = int(raw_input("Enter: 1=k epsilon, 2=Shear Stress Transport (SST): "))
if x == 1:
print 'k epsilon'
SetScriptVersion(Version="12.1")
system1 = GetSystem(Name="CFX")
setup1 = system1.GetContainer(ComponentName="Setup")
setup1.Edit()
setup1.SendCommand(Command="""FLOW: Flow Analysis 1
DOMAIN: Default Domain
FLUID MODELS:
TURBULENCE MODEL:
Option = k epsilon
END # TURBULENCE MODEL:
TURBULENT WALL FUNCTIONS:
Option = Scalable
END # TURBULENT WALL FUNCTIONS:
END # FLUID MODELS:
END # DOMAIN:Default Domain
END # FLOW:Flow Analysis 1""")
elif x == 2:
print 'Shear Stress Transport (SST)'
SetScriptVersion(Version="12.1")
system1 = GetSystem(Name="CFX")
setup1 = system1.GetContainer(ComponentName="Setup")
setup1.Edit()
setup1.SendCommand(Command="""FLOW: Flow Analysis 1
DOMAIN: Default Domain
FLUID MODELS:
TURBULENCE MODEL:
Option = SST
END # TURBULENCE MODEL:
TURBULENT WALL FUNCTIONS:
Option = Automatic
END # TURBULENT WALL FUNCTIONS:
END # FLUID MODELS:
END # DOMAIN:Default Domain
END # FLOW:Flow Analysis 1""")
print 'Done'
Depending on the value of x you input in the Command Window, the script includes the CCL
in the appropriate setup1.SendCommand argument to set the TURBULENCE MODEL and
TURBULENT WALL FUNCTIONS options in the FLOW: Flow Analysis 1 > DOMAIN:
Default Domain > FLUID MODELS object for either the k-Epsilon or the Shear Stress Transport
turbulence models.
if x == 1:
print 'Velocity'
results1.SendCommand(Command="""PLANE:Plane 1
Colour Mode = Variable
Colour Variable = 'Velocity'
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 67
Ansys CFX in Ansys Workbench
END""")
elif x == 2:
print 'Pressure'
results1.SendCommand(Command="""PLANE:Plane 1
Colour Mode = Variable
Colour Variable = Pressure
END""")
Depending on the value of x you input, the script includes the CCL in the appropriate res
ults1.SendCommand argument to set the values for Colour Mode and Colour Variable
in the PLANE:Plane 1 object for either the Velocity or Pressure variable.
• On the Define Run dialog box, the Reload run settings from file icon is not scriptable.
• CFX-Solver Manager actions that you can perform from the user interface after you start the run
are not scriptable.
Note:
You should not archive or restore a project while the CFX-Solver Manager is running.
Archiving CFX projects follows the steps above, but the resulting archive is created with the restrictions
listed below.
The following will be archived (provided that you choose the appropriate options when archiving):
• Flamelet libraries
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
68 of ANSYS, Inc. and its subsidiaries and affiliates.
Working with CFX in Workbench
• Initial values files provided by the Workbench Project Schematic and those manually selected by
you from within CFX-Pre
• Ansys Input File (provided by the Workbench Project Schematic or manually specified by you from
within CFX-Pre)
• RGP files
• If you choose to archive with the Result/Solution files option selected, CFX-Solver Results files are
included.
• If you choose to archive with the Imported files external to project directory option selected,
imported files are included. For example, an imported geometry file will be added to the im-
port_files directory in the archived version of the project.
• In the normal workflow, no files are written to the User_files directory. However, if you perform
operations such as the export of a file from CFD-Post, that file will be copied to User_files. If
you then choose to archive with the Items in the User_files folder option selected, such files are
included in the archive.
• Directory structures
• Customization files
• Custom solvers
• Files referenced from within another non-CFX file (for example, a file referenced by an Ansys Input
File).
5.5.8. Troubleshooting
The topics in this section include:
5.5.8.1. Resolving Execution Control Conflicts
To resolve the error, right-click the Solution cell and choose one of the following options:
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 69
Ansys CFX in Ansys Workbench
The Using execution control from <Setup|Solution> cell options enable you to decide how
to resolve the conflict on a case-by-case basis. Alternatively, you can choose one of the Using exe-
cution control from <Setup|Solution> cell always options. The latter options change your
Workbench preference. To change the preference manually, select (from Workbench) Tools > Options
> CFX and change the value of the Set the default execution control conflict option for the
solution cell field, which specifies the default value for the Solution cell property "Execution Control
Conflict Option". For details, see the description for "Execution Control Conflict Option" in Properties
Pane in the CFX Introduction (p. 37).
The Ansys CFX tutorials are generally written for Ansys CFX in stand-alone mode, but some also include
information on running the tutorial in Ansys Workbench.
Note:
When compiling a Fortran file with the cfx5mkext command in CFX-Pre in Ansys Work-
bench, a corresponding subdirectory is created for the output under the directory specified
by the Default Folder for Permanent File field (which is defined in the Ansys Workbench
> Tools > Options > Project Management pane). When performing this operation in CFX-
Pre in stand-alone mode, the subdirectory is created under your working directory.
In CFX-Pre in Ansys Workbench, when creating the user routine that calls the compiled
Fortran subroutine, on the CFX-Pre Basic Settings tab set the Library Path to the directory
named in the Default Folder for Permanent Files field (not to the working directory, as
you would when running CFX-Pre in stand-alone mode).
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
70 of ANSYS, Inc. and its subsidiaries and affiliates.
Chapter 6: Help On Help
The following topics are discussed:
6.1. Document Conventions
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 71
Help On Help
Important:
Files names with multiple consecutive spaces cannot be read by Ansys CFX.
Here the argument -verbose is optional, but you must specify a suitable filename.
On a Linux system, you may type the "\" characters, pressing Enter after each. However, on a Windows
machine you must enter the whole command without the "\" characters; continue typing if the
command is too long to fit in the command prompt window and press Enter only at the end of the
complete command.
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
72 of ANSYS, Inc. and its subsidiaries and affiliates.
Document Conventions
<os> refers to the short form of the name which CFX uses to identify the operating system in question.
<os> will generally be used for directory names where the contents of the directory depend on the
operating system but do not depend on the release of the operating system or on the processor type.
Wherever you see <os> in the text you should substitute with the operating system name. The correct
value can be determined by running:
<CFXROOT>/bin/cfx5info -os
<arch> refers to the long form of the name that CFX uses to identify the system architecture in
question. <arch> will generally be used for directory names where the contents of the directory depend
on the operating system and on the release of the operating system or the processor type. Wherever
you see <arch> in the text you should substitute the appropriate value for your system, which can
be determined by running the command:
<CFXROOT>/bin/cfx5info -arch
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 73
Release 2022 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
74 of ANSYS, Inc. and its subsidiaries and affiliates.