ANSYS Fluent Text Command List

ANSYS Fluent Text Command List
ANSYS, Inc. Release 2020 R1

Southpointe January 2020
2600 ANSYS Drive
Canonsburg, PA 15317 ANSYS, Inc. and
[email protected] ANSYS Europe,
Ltd. are UL
http://www.ansys.com registered ISO
(T) 724-746-3304 9001: 2015
(F) 724-514-9494 companies.
Copyright and Trademark Information
© 2020 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.
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.
U.S. Government Rights
For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use,
duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc.
software license agreement and FAR 12.212 (for non-DOD licenses).
Third-Party Software
See the legal information in the product help files for the complete Legal Notice for ANSYS proprietary software
and third-party software. If you are unable to access the Legal Notice, contact ANSYS, Inc.
Published in the U.S.A.

Table of Contents
I. Introduction ............................................................................................................................................. 1
1. Using This Manual ............................................................................................................................. 3
2. Text User Interface ............................................................................................................................ 7
2.1. Text Menu System ....................................................................................................................... 7
2.1.1. Command Abbreviation ..................................................................................................... 9
2.1.2. Command Line History ....................................................................................................... 9
2.1.3. Scheme Evaluation ........................................................................................................... 10
2.1.4. Aliases ............................................................................................................................. 10
2.2. Text Prompt System .................................................................................................................. 10
2.2.1. Numbers .......................................................................................................................... 11
2.2.2. Booleans .......................................................................................................................... 11
2.2.3. Strings ............................................................................................................................. 12
2.2.4. Symbols ........................................................................................................................... 12
2.2.5. Filenames ........................................................................................................................ 12
2.2.6. Lists ................................................................................................................................. 13
2.2.7. Evaluation ........................................................................................................................ 14
2.2.8. Default Value Binding ....................................................................................................... 15
2.3. Interrupts ................................................................................................................................. 15
2.4. System Commands ................................................................................................................... 15
2.4.1. System Commands for LINUX-based Operating Systems ................................................... 15
2.4.2. System Commands for Windows-based Operating Systems ............................................... 16
2.5. Text Menu Input from Character Strings .................................................................................... 17
2.6. Using the Text Interface Help System ......................................................................................... 18
A. Text Command List Changes in ANSYS Fluent 2020 R1 ....................................................................... 19
II. Meshing Mode ...................................................................................................................................... 21
1. boundary/ ..................................................................................................................................... 23
2. cad-assemblies/ ........................................................................................................................ 47
3. diagnostics/ .............................................................................................................................. 51
4. display/ ....................................................................................................................................... 53
5. exit ................................................................................................................................................ 71
6. file/ .............................................................................................................................................. 73
7. material-point/ ........................................................................................................................ 85
8. mesh/ .............................................................................................................................................. 87
9. objects/ ..................................................................................................................................... 125
10. parallel/ ................................................................................................................................. 135
11. report/ ..................................................................................................................................... 137
12. scoped-sizing/ ...................................................................................................................... 139
13. size-functions/ .................................................................................................................... 141
14. switch-to-solution-mode .................................................................................................. 143
A. Query and Utility Functions ............................................................................................................. 145
A.1. List Queries and Utility Functions ............................................................................................ 145
A.1.1. Using Boolean Operations with Lists ............................................................................... 153
A.1.2. Examples ....................................................................................................................... 154
A.2. Label Utility Functions ............................................................................................................ 154
A.2.1. Examples ....................................................................................................................... 158
A.3. Report Utility Functions .......................................................................................................... 158
A.4. Diagnostic Based Marking Utility Functions ............................................................................. 164
A.5. Mesh Setup Utility Functions .................................................................................................. 167
A.6. Mesh Operation Utility Functions ............................................................................................ 169
A.7. Miscellaneous Functions ......................................................................................................... 173
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. iii
Text Command List
B. Boundary Functions ........................................................................................................................ 175

B.1. Examples ................................................................................................................................ 184
C. Connect Functions .......................................................................................................................... 187
C.1. Examples ................................................................................................................................ 189
D. Size Field Functions ......................................................................................................................... 191
D.1. Examples ................................................................................................................................ 198
E. Wrap Functions ................................................................................................................................ 201
E.1. Examples ................................................................................................................................ 208
III. Solution Mode .................................................................................................................................... 211
1. adapt/ .......................................................................................................................................... 213
2. adjoint/ ..................................................................................................................................... 217
3. define/ ....................................................................................................................................... 225
4. display/ .................................................................................................................................... 299
5. exit / close-fluent ............................................................................................................. 319
6. file/ ............................................................................................................................................ 321
7. mesh/ ............................................................................................................................................ 333
8. parallel/ .................................................................................................................................. 339
9. plot/ ........................................................................................................................................... 343
10. report/ ..................................................................................................................................... 347
11. server/ ..................................................................................................................................... 355
12. solve/ ....................................................................................................................................... 357
13. surface/ ................................................................................................................................... 381
14. switch-to-meshing-mode .................................................................................................... 383
15. turbo-post/ ............................................................................................................................. 385
16. views/ ........................................................................................................................................ 387
17. battery-model/ ...................................................................................................................... 389
17.1. Single-Potential Empirical Battery Model ............................................................................... 389
17.2. Dual-Potential MSMD and Circuit Network Battery Models ..................................................... 390
18. Fuel Cell Text Commands ............................................................................................................ 393
18.1. Using the PEMFC Text User Interface ...................................................................................... 393
18.1.1. IV-Curve Calculations Using the Text Interface ............................................................... 395
18.2. Using the Fuel Cell and Electrolysis Text User Interface ........................................................... 397
18.2.1. IV-Curve Calculations Using the Text Interface ............................................................... 400
18.3. Using the Solid Oxide Fuel Cell With Unresolved Electrolyte Text User Interface ...................... 401
19. Magnetohydrodynamics Text Commands ................................................................................. 403
20. continuous-fiber/ ............................................................................................................... 405
iv of ANSYS, Inc. and its subsidiaries and affiliates.
List of Figures
8.1. Rezoning Multiply Connected Faces ...................................................................................................... 89
of ANSYS, Inc. and its subsidiaries and affiliates. v
vi of ANSYS, Inc. and its subsidiaries and affiliates.
Part I: Introduction
The section describes the general aspects of the text command interface for Fluent.
• Using This Manual (p. 3) gives a brief description of various chapters in this manual.
• Text User Interface (p. 7) gives an overview of the text command language, including basic syntax and
capabilities.
• Appendix A: Text Command List Changes in ANSYS Fluent 2020 R1 (p. 19) lists changes to the Text Command
List for the current release.
Chapter 1: Using This Manual
Important:
Under U.S. and international copyright law, ANSYS, Inc. is unable to distribute copies of the
papers listed in the bibliography, other than those published internally by ANSYS, Inc. Use
your library or a document delivery service to obtain copies of copyrighted papers.
This manual describes the text-based user interface of ANSYS Fluent Meshing which may be used for
scripting and other advanced workflows. Here is what you will find in each chapter and appendix:
Introduction:
• Text User Interface (p. 7) gives an overview of the text command language, including basic syntax and
capabilities.
• Appendix A: Text Command List Changes in ANSYS Fluent 2020 R1 (p. 19) lists changes to the Text Command
List for the current release.
Meshing Mode:
• boundary/ (p. 23) lists the commands used for creating, managing, modifying, deleting boundary (face)
zones and surface mesh.
• cad-assemblies/ (p. 47) lists commands used to interact with your CAD model.
• diagnostics/ (p. 51) lists commands used to find and repair face zone problems related to connectivity
and quality.
• display/ (p. 53) lists commands used to control the rendering of your model and mesh in the graphical
window.
• exit (p. 71) lists the command to close the program.
• file/ (p. 73) lists commands used to input and output your data.
• material-point/ (p. 85) lists commands used to manage material points in your model.
• mesh/ (p. 87) lists commands used to create, manage, modify and delete cell zones and volume mesh.
• objects/ (p. 125) lists commands used in the object-based meshing workflow, from CAD import to volume
fill.
• parallel/ (p. 135) lists commands specific to parallel processing.
• report/ (p. 137) lists commands used to return volume and surface mesh statistics such as counts or
quality.
of ANSYS, Inc. and its subsidiaries and affiliates. 3
Using This Manual
• scoped-sizing/ (p. 139) lists commands used to create and manage scoped size controls.
• size-functions/ (p. 141) lists commands used to create and manage size functions such as global or
periodic sizes.
• switch-to-solution-mode (p. 143) lists the command to transfer your mesh data to the Fluent solver.
• Appendix A: Query and Utility Functions (p. 145) lists API functions used to interact with your model by
passing information such as names or lists of zones or objects, statistics, and diagnostics. Boolean operations
and examples are included.
• Appendix B: Boundary Functions (p. 175) lists API functions used to manage boundary (face) zone mesh. Ex-
amples are included.
• Appendix C: Connect Functions (p. 187) lists API functions used to manage boundary (face) zone connectivity.
Examples are included.
• Appendix D: Size Field Functions (p. 191) lists API functions used to manage geodesic size controls and size
fields. Examples are included.
• Appendix E: Wrap Functions (p. 201) lists API functions used to manage your mesh in UTM cases. Examples
are included.
Solution Mode:
• adapt/ (p. 213) lists commands related to mesh adaption.
• adjoint/ (p. 217) lists commands related to the adjoint solver.
• define/ (p. 225) lists commands related to problem definition, such as models, boundary conditions, ma-
terials, etc.
window.
• exit / close-fluent (p. 319) lists the command to close the program.
• mesh/ (p. 333) lists commands used to create and manage mesh properties.
• plot/ (p. 343) lists commands specific to plotting data.
• report/ (p. 347) lists commands used to return statistics for the simulation.
• server/ (p. 355) lists commands used control the Fluent Remote Visualization Client and Server.
• solve/ (p. 357) lists commands used to create and manage solution controls, such as animation, cell registers,
monitors, initialization, etc.
• surface/ (p. 381) lists commands related to creating and manipulating surfaces.
4 of ANSYS, Inc. and its subsidiaries and affiliates.
• switch-to-meshing-mode (p. 383) lists the command to transfer your solution data to Fluent in meshing
mode.
• turbo-post/ (p. 385) lists commands related to results and reporting for turbomachinery.
• views/ (p. 387) lists commands related to camera and view manipulation in the graphics window.
Chapter 2: Text User Interface
In addition to the graphical user interface, the meshing mode of ANSYS Fluent also consists of a textual
command line reference.
The text user interface (TUI) is written in a dialect of Lisp called Scheme. Users familiar with Scheme
will be able to use the interpretive capabilities of the interface to create customized commands. The
TUI is described in the following sections:
2.1.Text Menu System
2.2.Text Prompt System
2.3. Interrupts
2.4. System Commands
2.5.Text Menu Input from Character Strings
2.6. Using the Text Interface Help System
2.1. Text Menu System

The text menu system provides a hierarchical interface to the program’s underlying procedural interface.
• You can easily manipulate its operation with standard text-based tools: input can be saved in files, modified
with text editors, and read back in to be executed, because it is text based.
• The text menu system is tightly integrated with the Scheme extension language, so it can easily be pro-
grammed to provide sophisticated control and customized functionality.
Note:
The console also contains an automatic-completer feature that shows the valid inputs as
soon as you begin typing so that you can quickly enter your intended commands. This feature
can be turned on/off in Preferences.
The menu system structure is similar to the directory tree structure of LINUX operating systems. When
you first start Fluent, you are in the "root" menu and the menu prompt is simply a caret/greater-than
symbol:
>
To generate a listing of the submenus and commands in the current menu, press Enter. The available
submenus and commands will depend on whether you are running Fluent in meshing mode or solution
mode.
For instance, the submenus and commands that are available from the root menu of the solution mode
are as follows:
Text User Interface
>Enter
adapt/ mesh/ surface/
define/ parallel/ switch-to-meshing-mode
display/ plot/ views/
exit report/
file/ solve/
By convention, submenu names end with a / to differentiate them from menu commands. To execute
a command, type its name (or an abbreviation). Similarly, to move down into a submenu, enter its name
or an abbreviation. When you move into the submenu, the prompt will change to reflect the current
menu name.
> display
/display > set
/display/set >
To move back to the previously occupied menu, type q or quit at the prompt.
/display/set > q
/display
You can move directly to a menu by giving its full pathname.

/display > /file
/display//file >
In the above example, control was passed from /display to /file without stopping in the root
menu. Therefore, when you quit from the /file menu, control will be passed directly back to /dis-
play.
/display//file > q
/display >
If you execute a command without stopping in any of the menus along the way, control will again be
returned to the menu from which you invoked the command.
/display /file start-journal jrnl
/display >
The text menu system provides online help for menu commands. The text menu online help system is
described in Using the Text Interface Help System (p. 18).
To edit the current command, you can position the cursor with the left and right arrow keys, delete
with the Backspace key, and insert text simply by typing.
For additional information, refer to the following sections:

2.1.1. Command Abbreviation
2.1.2. Command Line History
2.1.3. Scheme Evaluation
2.1.4. Aliases
Text Menu System
2.1.1. Command Abbreviation

To select a menu command, you need not type the entire name; you can type an abbreviation that
matches the command.
• A command name consists of "phrases" separated by hyphens.
• A command is matched by matching an initial sequence of its phrases.
• Matching of hyphens is optional.
• A phrase is matched by matching an initial sequence of its characters.
• A character is matched by typing that character.
The rules for "matching" a command are:
• If an abbreviation matches more than one command, then the command with the greatest number of
matched phrases is chosen.
• If more than one command has the same number of matched phrases, then the first command to appear
in the menu is chosen.
For example, each of the following will match the given command set-ambientcolor: set-
ambient-color, s-a-c, sac, and sa.
• When abbreviating commands, sometimes your abbreviation will match more than one command. In
such cases, the first command is selected.
• Occasionally, there is an anomaly such as lint not matching lighting-interpolation because

the li gets absorbed in lights-on? and then the nt does not match interpolation.
This can be resolved by choosing a different abbreviation, such as liin, or l-int.
2.1.2. Command Line History

You can use the up and down arrow keys on your keyboard to go through recently used commands
that are stored in history. By default, command-history will store only the last ten commands. This
can be changed (for example to 15) by using the following command:
> (set! *cmd-history-length* 15)
Important:
Command-history is not available if the ANSYS Fluent application is started with -g options
(see Command Line Startup Options in the Fluent User's Guide).
Important:
The user inputs supplied as the arguments of the TUI command or alias will not be saved
in history. By way of illustration, consider the following entry in the TUI:
Text User Interface
> rc new_file.cas
Important:
In history, only rc (an alias for read-case) will be saved, since new_file.cas is a user
input to the alias-function.
Commands recalled from history can be edited or corrected using the Backspace key and the left
and right arrow keys.
2.1.3. Scheme Evaluation

If you enter an open parenthesis, (, at the menu prompt, then that parenthesis and all characters up
to and including the matching closing parenthesis are passed to Scheme to be evaluated, and the
result of evaluating the expression is displayed.
> (define a 1)
> (+ a 2 3 4)
10
2.1.4. Aliases
Command aliases can be defined within the menu system. As with the Linux csh shell, aliases take
precedence over command execution. The following aliases are predefined in Cortex: error, pwd,
chdir, ls, ., and alias.
error
displays the Scheme object that was the “irritant” in the most recent Scheme error interrupt.
pwd
prints the working directory in which all file operations will take place.
chdir
will change the working directory.
ls
lists the files in the working directory.
. (period)
prompts you for a journal file name and then run the journal file you have specified.
alias
displays the list of symbols currently aliased.
2.2. Text Prompt System

Commands require various arguments, including numbers, filenames, yes/no responses, character strings,
and lists. A uniform interface to this input is provided by the text prompt system. A prompt consists of
Text Prompt System
a prompt string, followed by an optional units string enclosed in parentheses, followed by a default
value enclosed in square brackets. The following shows some examples of prompts:
filled-mesh? [no] Enter
shrink-factor [0.1] Enter
line-weight [1] Enter
title [""]Enter
The default value for a prompt is accepted by pressing Enter on the keyboard or typing a , (comma).
Important:
Note that a comma is not a separator. It is a separate token that indicates a default value.
The sequence “ 1,2” results in three values; the number 1 for the first prompt, the default
value for the second prompt, and the number 2 for the third prompt.
A short help message can be displayed at any prompt by entering a ?. (See Using the Text Interface
Help System (p. 18).)
To abort a prompt sequence, simply press Ctrl+c.
2.2.1. Numbers
The most common prompt type is a number. Numbers can be either integers or real numbers. Valid
numbers are, for example, 16, -2.4, .9e5, and +1e-5.
• Integers can also be specified in binary, octal, and hexadecimal form.
• The decimal integer 31 can be entered as 31, #b11111, #o37, or #x1f.
• In Scheme, integers are a subset of reals, so you do not need a decimal point to indicate that a number
is real; 2 is just as much a real as 2.0.
• If you enter a real number at an integer prompt, any fractional part will be truncated. For example, 1.9
will become 1.
2.2.2. Booleans
Some prompts require a yes-or-no response. A yes/no prompt will accept either yes or y for a positive
response, and no or n for a negative response. Yes/no prompts are used for confirming potentially
dangerous actions such as overwriting an existing file, exiting without saving case, data, mesh, and
so on.
Some prompts require actual Scheme Boolean values (true or false). These are entered with the
Scheme symbols for true and false, #t and #f.
Text User Interface
2.2.3. Strings
Character strings are entered in double quotes, for example, “red”. Plot titles and plot legend titles
are examples of character strings. Character strings can include any characters, including blank spaces
and punctuation.
2.2.4. Symbols
Symbols are entered without quotes. Zone names, surface names, and material names are examples
of symbols. Symbols must start with an alphabetical character (that is, a letter), and cannot include
any blank spaces or commas.
You can use wild cards to specify zone names when using the TUI. Some examples are:
• * will translate as “all zones”.
For example,
– /display/boundary-grid * enables you to display all the boundary zones in the mesh.
– /boundary/delete-island-faces wrap* enables you to delete island faces on all zones

prefixed by wrap.
• > will translate as “all zones visible in the graphics window”.
For example, /boundary/manage/delete >, yes enables you to delete all visible zones.
• ^ will translate as “all zones selected in the graphics window”.
For example, /boundary/manage/delete ^, yes enables you to delete all selected zones.
• [object_name will translate as “all zones with the name object_name”.
For example, /boundary/manage/delete [box, yes enables you to delete all zones of an
object with the name box.
• [object_name/label_name will translate as "all zones with label_name of object_name"
For example, /boundary/manage/delete [fluid/box*, yes enables you to delete all

zones of an object with the name fluid and comprising face zone labels box*.
If you use a wild card for an operation that requires a single zone as input, you will be prompted to
specify a single zone from the list of those that match the expression specified.
> /boundary/manage/name wall* <Enter>
wall-1 wall-3 wall-5

wall-2 wall-4 wall-6
Zone Name [ ]
2.2.5. Filenames
Filenames are actually just character strings. For convenience, filename prompts do not require the
string to be surrounded with double quotes. If, for some exceptional reason, a filename contains an
embedded space character, then the name must be surrounded with double quotes.
Text Prompt System
One consequence of this convenience is that filename prompts do not evaluate the response. For
example, the sequence
> (define fn "valve.ps")
fn
> hc fn
will end up writing a picture file with the name fn, not valve.ps. Since the filename prompt did
not evaluate the response, fn did not get a chance to evaluate “valve.ps” as it would for most
other prompts.
2.2.6. Lists
Some functions in ANSYS Fluent require a “list” of objects such as numbers, strings, Booleans, and so
on. A list is a Scheme object that is simply a sequence of objects terminated by the empty list, ’().
Lists are prompted for an element at a time, and the end of the list is signaled by entering an empty
list. This terminating list forms the tail of the prompted list, and can either be empty or can contain
values. For convenience, the empty list can be entered as () as well as the standard form ’(). Nor-
mally, list prompts save the previous argument list as the default. To modify the list, overwrite the
desired elements and terminate the process with an empty list. For example,
element(1) [()] 1
element(2) [()] 10
element(3) [()] 100
element(4) [()] Enter
creates a list of three numbers: 1, 10, and 100. Subsequently,

element(1) [1] Enter
element(4) [()] 1000
element(5) [()] Enter
adds a fourth element. Then

element(3) [100] ()
leaves only 1 and 10 in the list. Subsequently entering

element(1) [1] ,,’(11 12 13)
creates a five element list: 1, 10, 11, 12, and 13. Finally, a single empty list removes all elements
element(1) [1] ()
Text User Interface
A different type of list, namely, a “list-of-scalars” contains pick menu items (and not list items) for
which a selection has to be made from listed quantities, which are available at the Enter prompt.
Hence, a list-of-scalars cannot be entered as a list.
An example of a “list-of-scalars” consists of the following:
2.2.7. Evaluation
All responses to prompts (except filenames, see above) are evaluated by the Scheme interpreter before
they are used. You can therefore enter any valid Scheme expression as the response to a prompt. For
example, to enter a unit vector with one component equal to 1/3 (without using your calculator),
/foo> set-xy
x-component [1.0] (/ 1 3)
y-component [0.0] (sqrt (/ 8 9))
System Commands
or, you could first define a utility function to compute the second component of a unit vector,
> (define (unit-y x) (sqrt (- 1.0 (* x x))))
unit-y
/foo> set-xy
x-component [1.0] (/ 1 3)
y-component [0.0] (unit-y (/ 1 3))
2.2.8. Default Value Binding

The default value at any prompt is bound to the Scheme symbol “ _” (underscore) so that the default
value can form part of a Scheme expression. For example, if you want to decrease a default value so
that it is one-third of the original value, you could enter
shrink-factor [0.8] (/ _ 3)
2.3. Interrupts
The execution of the code can be halted by pressing the Ctrl+c, at which time the present operation
stops at the next recoverable location.
2.4. System Commands

The way you execute system commands with the ! (bang) shell escape character will be slightly different
for Linux and Windows systems.
For additional information, see the following sections:

2.4.1. System Commands for LINUX-based Operating Systems
2.4.2. System Commands for Windows-based Operating Systems
2.4.1. System Commands for LINUX-based Operating Systems

If you are running ANSYS Fluent under a Linux-based operating system, all characters following the
! up to the next newline character will be executed in a subshell. Any further input related to these
system commands must be entered in the window in which you started the program, and any screen
output will also appear in that window. (Note that if you started ANSYS Fluent remotely, this input
and output will be in the window in which you started Cortex.)
> !rm junk.*
> !vi script.rp
!pwd and !ls will execute the Linux commands in the directory in which Cortex was started. The
screen output will appear in the window in which you started ANSYS Fluent, unless you started it
remotely, in which case the output will appear in the window in which you started Cortex. (Note that
!cd executes in a subshell, so it will not change the working directory either for ANSYS Fluent or for
Cortex, and is therefore not useful.) Typing cd with no arguments will move you to your home dir-
ectory in the console.
Text User Interface
ANSYS Fluent includes three system command aliases (pwd, ls, and chdir) that will be executed in
your working directory with output displayed in the ANSYS Fluent console. Note that these aliases
will invoke the corresponding Linux commands with respect to the parent directory of the case file.
For example, pwd prints the parent directory of the case file in the ANSYS Fluent console, while !pwd
prints the directory from which you started ANSYS Fluent in the Linux shell window where you started
ANSYS Fluent.
Several examples of system commands entered in the console are shown below. The screen output
that will appear in the window in which ANSYS Fluent was started (or, if you started the program re-
motely, in the window in which Cortex was started) follows the examples.
Example input (in the ANSYS Fluent console):

> !pwd
> !ls valve*.*
Example output (in the window in which ANSYS Fluent— or Cortex, if you started the program re-
motely—was started):
/home/cfd/run/valve
valve1.cas valve1.msh valve2.cas valve2.msh
2.4.2. System Commands for Windows-based Operating Systems

If you are running ANSYS Fluent under a Windows operating system, all characters following the !
up to the next newline character will be executed. The results of a command will appear in the ANSYS
Fluent console, or in a separate window if the command starts an external program, such as Notepad.
> !del junk.*
> !notepad script.rp
!cd and !dir will execute the DOS commands and the screen output will appear in the ANSYS
Fluent console. The !cd command with no argument will display the current working directory in
the ANSYS Fluent console.
Several examples of system commands entered in the console are shown below.
Example input (in boxes) and output (in the ANSYS Fluent console):
> !cd
p:/cfd/run/valve
> !dir valve*.*/w
Volume in drive P is users

Volume Serial Number is 1234-5678
Directory of p:/cfd/run/valve
valve1.cas valve1.msh valve2.cas valve2.msh
4 File(s) 621,183 bytes
0 Dir(s) 1,830,088,704 bytes free
Text Menu Input from Character Strings
2.5. Text Menu Input from Character Strings

When writing a Scheme extension function for ANSYS Fluent, it is often convenient to be able to include
menu commands in the function. This can be done with ti-menu-load-string. For example, to
open graphics window 2, use
(ti-menu-load-string "di ow 2")
A Scheme loop that will open windows 1 and 2 and display the front view of the mesh in window 1
and the back view in window 2 is given by
(for-each
(lambda (window view)
(ti-menu-load-string (format #f "di ow ~a gr view rv ~a"
window view)))
’(1 2)
’(front back))
This loop makes use of the format function to construct the string used by menu-load-string.
This simple loop could also be written without using menu commands at all, but you need to know
the Scheme functions that get executed by the menu commands to do it:
(for-each
(lambda (window view)
(cx-open-window window)
(display-mesh)
(cx-restore-view view))
’(1 2) ’(front back))
String input can also provide an easy way to create aliases within ANSYS Fluent. For example, to create
an alias that will display the mesh, you could type the following:
(alias ’dg (lambda () (ti-menu-load-string "/di gr")))
Then any time you enter dg from anywhere in the menu hierarchy, the mesh will be drawn in the active
window.
Important:
ti-menu-load-string evaluates the string argument in the top level menu. It ignores
any menu you may be in when you invoke ti-menu-load-string.
As a result, the command

(ti-menu-load-string "open-window 2 gr") ; incorrect usage
will not work even if you type it from within the display/ menu—the string itself must
cause control to enter the display/ menu, as in
(ti-menu-load-string "display open-window 2 mesh")
Text User Interface
2.6. Using the Text Interface Help System

The text user interface provides context-sensitive online help. Within the text menu system, you can
obtain a brief description of each of the commands by entering a ? followed by the command in
question.
Example:
> ?dis
display/: Enter the display menu.
You can also enter a lone ? to enter “help mode.” In this mode, you need only enter the command or
menu name to display the help message. To exit the help mode type q or quit as for a normal menu.
Example:
> ?
[help-mode]> di
display/: Enter the display menu.
[help-mode]> pwd
pwd: #[alias]
(LAMBDA ()
(BEGIN
(SET! pwd-cmd ((LAMBDA n
n) ’system (IF (cx-send ’(unix?))
"pwd"
"cd")))
(cx-send pwd-cmd)))
[help-mode]> q
To access the help, type a ? at the prompt when you are prompted for information.
Example:
> display/annotate Annotation text [""] ?
Annotation text [""]
Appendix A. Text Command List Changes in ANSYS Fluent 2020 R1
For a complete listing of changes to the Text Command List for ANSYS Fluent 2020 R1, refer to Text
Command Changes in ANSYS Fluent 2020 R1 in the Fluent Migration Manual.
Part II: Meshing Mode
The section describes the text command listing for Fluent in Meshing mode.
• boundary/ (p. 23) lists the commands used for creating, managing, modifying, deleting boundary (face)
zones and surface mesh.
• cad-assemblies/ (p. 47) lists commands used to interact with your CAD model.
• diagnostics/ (p. 51) lists commands used to find and repair face zone problems related to connectivity
and quality.
window.
• exit (p. 71) lists the command to close the program.
• material-point/ (p. 85) lists commands used to manage material points in your model.
• mesh/ (p. 87) lists commands used to create, manage, modify and delete cell zones and volume mesh.
• objects/ (p. 125) lists commands used in the object-based meshing workflow, from CAD import to volume
fill.
• report/ (p. 137) lists commands used to return volume and surface mesh statistics such as counts or
quality.
• scoped-sizing/ (p. 139) lists commands used to create and manage scoped size controls.
• size-functions/ (p. 141) lists commands used to create and manage size functions such as global or
periodic sizes.
• switch-to-solution-mode (p. 143) lists the command to transfer your mesh data to the Fluent solver.
• Appendix A: Query and Utility Functions (p. 145) lists API functions used to interact with your model by
passing information such as names or lists of zones or objects, statistics, and diagnostics. Boolean operations
and examples are included.
• Appendix B: Boundary Functions (p. 175) lists API functions used to manage boundary (face) zone mesh. Ex-
amples are included.
• Appendix C: Connect Functions (p. 187) lists API functions used to manage boundary (face) zone connectivity.
Examples are included.
• Appendix D: Size Field Functions (p. 191) lists API functions used to manage geodesic size controls and size
fields. Examples are included.
• Appendix E: Wrap Functions (p. 201) lists API functions used to manage your mesh in UTM cases. Examples
are included.
Chapter 1: boundary/
auto-slit-faces
slits all boundary faces with cells on both sides (these cells must be in the same cell zone). A displacement
can be specified to provide thickness to the boundary.
boundary-conditions/
contains options for copying or clearing boundary conditions when a case file is read.
clear
clears the boundary conditions assigned to the specified face zones.
clear-all
clears the boundary conditions assigned to all the face zones.
copy
enables you to copy the boundary conditions from the face zone selected to the face zones specified.
check-boundary-mesh
reports the number of Delaunay violations on the triangular surface mesh and the number of isolated
nodes.
check-duplicate-geom
displays the names of the duplicate surfaces and prints maximum and average distance between them.
clear-marked-faces
clears marked faces.
clear-marked-nodes
clears nodes that were marked using the mark-duplicate-nodes command.
compute-bounding-box
computes the bounding box for the zones specified.
count-free-nodes
reports the number of boundary nodes associated with edges having only one attached face.
count-marked-faces
reports the number of marked faces.
count-unused-bound-node
counts the unused boundary nodes in the domain.
count-unused-faces
lists the number of boundary faces that are not used by any cell.
count-unused-nodes
lists the number of boundary nodes that are not used by any cell.
boundary/
create-bounding-box
creates the bounding box for the specified zones. You can specify the zone type, name, edge length, and
the extents of the box, as required. You can also optionally create a geometry object from the bounding
box created.
create-cylinder
creates a cylinder by specifying the axis, radius, and edge length or three arc nodes, the axial delta, the
radial gap, and the edge length. You can also specify the prefix for the zone being created, as required.
You can also optionally create a geometry object from the cylinder created.
create-plane-surface
creates a plane surface by specifying either the axis direction, axial location, and the extents of the surface
or three points defining the plane. You can also optionally create a geometry object from the plane surface
created.
create-revolved-surface
creates a revolved surface by rotating the specified edge through the angle specified. Specify the number
of segments, scale factor, and the pivot point and axis of rotation. You can also optionally create a geometry
object from the revolved surface created.
create-swept-surface
creates a surface by sweeping the specified edge in the direction specified. You need to specify the distance
to sweep through and the number of offsets, as required. You can also optionally create a geometry object
from the swept surface created.
delete-all-dup-faces
searches for faces on all boundary zones that have the same nodes and deletes the duplicates.
delete-duplicate-faces
searches for faces on a specified zone that have the same nodes and deletes the duplicates.
Duplicate faces may be present if you generated the boundary mesh using a third-party grid gener-
ator, or if you have used the slit-boundary-face command to modify the boundary mesh
and then merged the nodes.
delete-free-edge-faces
enables you to remove faces with the specified number of free edges from the specified boundary zones.
delete-island-faces
enables you to delete faces in a non-contiguous region of a face zone.
delete-unconnected-faces
enables you to delete the unconnected face-zones.
delete-unused-faces
deletes all the boundary faces that are not used by any cell.
delete-unused-nodes
deletes the boundary nodes that are not used by any boundary faces.
edge-limits
prints the length of the shortest and longest edges on the boundary. This information is useful for setting
initial mesh parameters and refinement controls.
face-distribution
reports the distribution of face quality in the text window.
face-skewness
lists the worst face skewness.
feature/
enables you to create and modify features.
copy-edge-zones
copies the specified edge zone(s) to new edge zone(s).
create-edge-zones
extracts edge loops for the specified face zone(s) based on the feature method specified. You also
need to specify an appropriate value for feature angle when using the fixed-angle method.
Note:
The Face Seed approach cannot be used when creating edge loops using text com-
mands.
delete-degenerated-edges
deletes degenerated edges (edges where the two end nodes are the same) for the edge zone(s) specified.
delete-edge-zones
deletes the specified edge zone(s)
edge-size-limits
reports the minimum, maximum, and average edge length for the specified edge zone(s) in the console.
group
associates the specified edge zone(s) with the specified face zone.
intersect-edge-zones
intersects the specified edge loops to create a new edge loop comprising the common edges. You
can enable automatic deleting of overlapped edges and specify an appropriate intersection tolerance.
list-edge-zones
lists the name, ID, type, and count for the specified edge zone(s).
merge-edge-zones
merges multiple edge loops of the same type into a single loop.
orient-edge-direction
orients the edges on the loop to point in the same direction.
project-edge-zones
projects the edges of the specified loop onto the specified face zone using the specified projection
method.
remesh-edge-zones
remeshes the specified edge loop(s), modifying the node distribution according to the specified
remeshing method, spacing values, and feature angle. You can also enable quadratic reconstruction,
if required.
boundary/
reverse-edge-direction
reverses the direction of the edge loop.
separate-delete-small-edges
separates the edge zones based on the feature angle specified, and then deletes the edges having a
count smaller than the minimum count specified.
separate-edge-zones
separates the specified edge loop based on connectivity and the specified feature angle.
separate-edge-zones-by-seed
separates the edge loop based on the seed edge specified. The edge zone separation angle is used to
separate the edge zone (default 40).
toggle-edge-type
toggles the edge type between boundary and interior.
ungroup
ungroups previously grouped edge zones.
fix-mconnected-edges
resolves multi-connected edges/non-manifold configurations in the boundary mesh by deleting fringes
and overlaps based on threshold values specified.
improve/
enables you to improve boundary surfaces.
collapse-bad-faces
enables you to collapse the short edge of faces having a high aspect ratio or skewness in the specified
face zone(s).
degree-swap
enables you to improve the boundary mesh by swapping edges based on a node degree value other
than 6. The node degree is defined as the number of edges connected to the node.
improve
enables you to improve the boundary surface quality using skewness, size change, aspect ratio, or area
as the quality measure.
smooth
enables you to improve the boundary surface using smoothing.
swap
enables you to improve the boundary surface using edge swapping.
jiggle-boundary-nodes
randomly perturbs all boundary nodes based on an input tolerance. Some nodes will be perturbed less
than the tolerance value, while others will be perturbed by half of the tolerance value in all three coordinate
directions.
make-periodic
enables you to make the specified boundaries periodic. You can specify the type of periodicity (rotational
or translational), the angle, pivot, and axis of rotation, for rotational periodicity or the translational shift
for translational periodicity.
For each of the zones specified, a corresponding periodic shadow boundary zone will be created.
manage/
contains options for manipulating the boundary zones.
auto-delete-nodes?
specifies whether or not unused nodes should be deleted when their face zone is deleted.
change-prefix
enables you to change the prefix for the specified face zones.
copy
copies all nodes and faces of the specified face zone(s).
create
creates a new face zone.
delete
deletes the face zone.
flip
reverses the normal direction of the specified boundary zone(s).
id
specifies a new boundary zone ID. If there is a conflict, the change will be ignored.
list
prints information about all boundary zones.
merge
merges face zones.
name
gives a face zone a new name.
orient
consistently orients the faces in the specified zones.
origin
specifies a new origin for the mesh, to be used for face zone rotation and for periodic zone creation.
The default origin is (0,0,0).
remove-suffix
removes the suffix (characters including and after the leftmost ":") in the face zone names.
rotate
rotates all nodes of the specified face zone(s).
rotate-model
rotates all nodes of the model through the specified angle, based on the specified point and axis of
rotation.
scale
scales all nodes of the specified face zone(s).
boundary/
scale-model
scales all nodes of the model by multiplying the node coordinates by the specified scale factors (x, y,
z).
translate
translates all nodes of the specified face zone(s).
translate-model
translates all nodes of the model by the specified translation offsets (x, y, z).
Note:
The translation offsets are interpreted as absolute numbers in meshing mode. In

solution mode, however, the translation offsets are assumed to be distances in the
length unit set. This may lead to differences in domain extents reported after trans-
lating the mesh in the respective modes.
type
changes the boundary type of the face zone.
Note:
When changing the boundary type of any zone to type interior, ensure that there
is a single cell zone across the interior boundary. Retaining multiple cell zones
across an interior boundary can cause undesirable results with further tet meshing
or smoothing operations.
Also, face zones having no/one neighboring cell zone should not be changed to type
interior.
The mesh check will issue a warning if multiple cell zones are maintained across an
interior boundary. The boundary type in such cases should be set to internal
instead.
user-defined-groups
enables you to manipulate user-defined groups.
activate
activates the specified user-defined groups.
create
creates the user-defined group comprising the specified zones.
delete
deletes the specified user-defined group.
list
lists the groups in the console.
update
enables you to modify an existing group.
mark-duplicate-nodes
marks duplicate nodes. The marked nodes will appear in the grid display when nodes are displayed. For
a list of duplicate nodes, set the /report/verbosity level to 2 before using the mark-duplicate-
nodes command.
mark-face-intersection
marks intersecting faces. Intersection is detected if the line defined by any two consecutive nodes on a
face intersects any face in the current domain. The marked faces will appear in the grid display when faces
are displayed. For a list of intersecting faces, set the /report/verbosity level to 2 before using the
mark-face-intersection command.
mark-face-proximity
marks faces that are in proximity to each other.
Face A is considered to be in proximity to face B if any of the nodes on face A are within the calcu-
lated proximity distance from face B. The proximity distance is calculated based on the specified
relative distance and the sphere radius. The sphere radius is determined by the maximum distance
from the centroid of the face to its nodes. The marked faces will appear in the grid display when
faces are displayed.
For a list of faces in proximity to each other, set the /report/verbosity level to 2 before using
the mark-face-proximity command.
mark-faces-in-region
marks the faces that are contained in a specified local refinement region.
merge-nodes
merges duplicate nodes.
merge-small-face-zones
merges the face zones having area less than the minimum area.
modify/
contains commands used to modify the boundary mesh.
analyze-bnd-connectvty
finds and marks free edges and nodes and multiply-connected edges and nodes. This process is neces-
sary if the boundary mesh has been changed with Scheme functions.
clear-selections
clears all selections.
clear-skew-faces
clears faces that were marked using the mark-skew-face command.
collapse
collapses pairs of nodes, edge(s), or face(s). If a pair of nodes is selected, both the nodes are deleted
and a new node is created at the midpoint of the two nodes. If a triangular face is selected, the complete
face is collapsed into a single node at the centroid of the face.
create
creates a boundary face if the selection list contains 3 nodes and an optional zone. If the selection list
contains positions, then nodes are created.
boundary/
create-mid-node
creates a node at the midpoint between two selected nodes.
delete
deletes all selected faces and nodes.
delta-move
moves the selected node by specified magnitude.
deselect-last
removes the last selection from the selection list.
hole-feature-angle
specifies the feature angle for consideration of holes in the geometry.
list-selections
lists all of the selected objects.
local-remesh
remeshes marked faces or faces based on selections in the graphics window. Select the faces to be
remeshed and specify the sizing source (constant-size, geometry, or size-field), the number
of radial layers of faces to be remeshed (rings), the feature angle to be preserved while remeshing
the selected faces, and the size for constant size remeshing (if applicable).
mark-skew-face
marks faces that should be skipped when the worst skewed face is reported using the Modify
Boundary dialog box. This enables you to search for the next skewed face.
merge
merges pairs of nodes. The first node selected is retained, and the second is the duplicate that is
merged.
move
moves the selected node to the selected position if the selection list contains a node and a position.
next-skew
finds the triangular face of nearest lower skewness value than that of the worst skewed face. The face
ID, its skewness, the longest edge ID, and the node ID opposite to the longest edge are displayed in
the console.
repair
repairs zones by filling all holes associated with free faces. Specify the face zones for the repair operation.
repair-options/
contains
rezone
moves the selected faces from their current zone into the selected zone, if the selection list contains
a zone and one or more faces.
select-entity
adds a cell, face, or node to the selection list by entering the name of the entity.
select-filter
selects a filter. The possible filters are off, cell, face, edge, node, zone, position, object,
and size. If off is chosen, then when a selection is made, it is first checked to see if it is a cell, then
a face, an edge, and so on. When the node filter is used, and if a cell or face is selected, the node closest
to the selection point is picked. Thus, the nodes do not have to be displayed, to be picked.
select-position
adds a position to the selection list by entering the coordinates of the position.
select-probe
selects the probe function. The possible functions are:
• box enables the selection of a group of entities within a box, to be used in conjunction with
boundary modification functions.
• label prints the selection label in the graphics window
• off disables the mouse probes.
• polygon enables the selection of a group of entities within a polygonal region, to be used in con-
junction with boundary modification functions.
• print prints the information on the selection in the console window.
• select adds the selection to the selection list
select-visible-entities?
enables you to select only visible entities (nodes, edges, faces, zones, objects) when the box select or
polygon select options are used. Ensure that the model is zoomed to an appropriate level for correct
selection.
Tip:
To quickly revert to the behavior of R16.1 or earlier, enable transparency.
Note:
• If the mesh is not connected, all entities (nodes, edges, faces, zones, objects) will be se-
lected irrespective of whether they are visible or not.
• This visual selection behavior works only on local displays and may generate warning
messages when attempting selection on a remote system.
select-zone
adds a zone to the selection list by entering the zone name or ID.
show-filter
shows the current filter.
show-probe
shows the current probe function.
boundary/
skew
finds the face with the highest (worst) skewness, selects it in the graphics window, and reports its
skewness and zone ID in the console window.
skew-report-zone
enables you to select the zone for which you want to report the skewness. You can either specify zone
name or zone ID.
smooth
uses Laplace smoothing to modify the position of the nodes in the selection list. It moves the selected
node to a position computed from an average of its node neighbors. The new position is an average
of the neighboring node coordinates and is not reprojected to the discrete surface.
split-face
splits two selected faces into four faces.
swap
swaps boundary edges (of triangular faces) if the selection list contains edges.
undo
undoes the previous operation. When an operation is performed, the reverse operation is stored on
the undo stack. For example, a create operation places a delete on the stack, and a delete adds a create
operation.
The undo operation requires that the name of the object exist when the action is undone. If
the name does not exist, then the undo will fail. You can undo the last few operations, but if
many operations are being performed it is recommended that you also save the mesh periodically.
orient-faces-by-point
orients the normals based on the specified material point.
print-info
prints information about the grid in the text window.
project-face-zone
projects nodes on a selected face zone onto a target face zone. Projection can be performed based on
normal direction, closest point, or specified direction.
recover-periodic-surfaces
restores the periodic relationship between face zones. You will be prompted for the type (rotational
or translational), method (semi-automatic, automatic, or manual, depending on the periodicity type)
and for face zones. Periodicity information (angle, pivot point, axis of rotation, or translational shift)
are read in with the mesh file.
• The semi-automatic option prompts you for the source boundary zones and the periodicity inform-
ation.
• The automatic option prompts you for the source boundary zones.
• The manual option (available only for rotational periodicity) prompts you for the source and target
boundary zones, as well as the periodicity information.
refine/
discusses the commands used to refine the boundary mesh.
auto-refine
automatically refines a face zone based on proximity. The original face zone is treated as a background
mesh. Faces are refined by multiple face splitting passes, so that no face is in close proximity to any
face in the current domain.
clear
clears all refinement marks from all boundary faces.
count
counts the number of faces marked on each boundary zone.
limits
prints a report of the minimum and maximum size of each specified zone. This report will also tell you
how many faces on each zone have been marked for refinement.
local-regions
enters the local refinement menu.
define
defines the refinement region according to the specified parameters.
delete
deletes the specified region.
init
creates a region encompassing the entire geometry.
list-all-regions
lists all the refinement regions in the console.
mark
marks the faces for refinement.
refine
refines the marked faces.
remesh/
has a set of commands for remeshing the face zones.
clear-marked-faces
clears the highlighting of the triangles that are marked.
coarsen-and-refine
remeshes (coarsens/refines) the boundary face zones based on the computed size field. Specify the
boundary face zones to be remeshed, the boundary edge zones, feature angle, and corner angle. Ad-
ditionally, specify whether the current boundary face zones should be replaced by the remeshed face
zones after the operation is complete.
controls/
enters the edge loop tools text menu.
delete-overlapped?
toggles the deletion of region of overlap of the two surfaces.
boundary/
direction
specifies the direction of the edge loop projection.
intersect/
enters the intersect control menu.
absolute-tolerance?
enables you to switch between the use of absolute and relative tolerance. By default, the relative
tolerance value is used.
delete-overlap?
enables/disables the deletion of overlapped edges. It toggles the automatic deletion of region
of overlap of the two surfaces. This option is used by while remeshing overlapping zones and
retriangulating prisms. By default, this option is enabled.
feature-angle
specifies the minimum feature angle that should be considered while retriangulating the
boundary zones. All the edges in the zone having feature angle greater than the specified
feature angle are retained. This option is useful for preserving the shape of the intersecting
boundary zones. The default value of feature angle is 40, however, a value in the range of
10–50 degrees is recommended. A large value may distort the shape of the intersecting
boundary zones.
ignore-parallel-faces?
Default is yes. If there are close-to-parallel faces, set to no to separate the zones and avoid
creating an intersection loop.
join-match-angle
specifies the allowed maximum angle between the normals of the two overlapping surfaces
to be joined. This parameter is used to control the size of the join region.
join-project-angle
specifies the allowed maximum angle between the face normal and the project direction for
the overlapping surfaces to be joined. This parameter is used to control the size of the join re-
gion.
refine-region?
enables you to refine the regions that are modified during the intersect operations. It toggles
the refinement of the intersecting regions after performing any of the intersection operation.
This operation improves the quality of the resulting mesh, however, this option is disabled
by default.
remesh-post-intersection?
used to enable or disable automatic post-remesh operation after any connect operation (join,
intersect, or stitch).
retri-improve?
enables you to improve the mesh. After performing any intersection operation, the slivers are
removed along the curve of intersection, Laplace smoothing is performed, and followed by
the edge swapping. Laplace smoothing is also performed for insert-edge-zone, remesh-
overlapped-zones, and prism-retriangulation options. Smoothing is performed
again. The smooth-swap operations can be controlled by changing the various defaults such
as swapping iterations, smoothing iterations, etc.
separate?
enables the automatic separation of intersected zones.
stitch-preserve?
indicates that shape of the first zone specified is to be preserved. This option is enabled by
default.
tolerance
specifies the tolerance value for the intersect operations.
within-tolerance?
performs the intersection operation only within the specified tolerance value. It is useful only
for the Intersect option.
project-method
specifies the method for projecting edge loops.
proximity-local-search?
includes the selected face for proximity calculation.
quadratic-recon?
enables/disables quadratic reconstruction of edge loops.
remesh-method
specifies the method to be used for the node distribution on the edge loop.
spacing
sets the node spacing for the edge loop.
tolerance
sets the tolerance for determining if two edges intersect.
create-all-intrst-loops
creates edge loop of intersection for all boundary zones in current domain.
create-edge-loops
creates edge loops for a specified face zone, based on feature angle.
create-intersect-loop
creates an interior edge loop at the intersection between two adjacent face zones. Edges created in
this way will not be remeshed by default.
create-join-loop
creates edge loop on boundary of the region of overlap of two surfaces.
create-stitch-loop
creates edge loops for connecting two surfaces along their free edges.
delete-overlapped-edges
deletes edges that overlap selected edge loops.
faceted-stitch-zones
performs the faceted stitching of zones.
boundary/
insert-edge-zone
inserts an edge zone into a triangulated boundary face zone.
intersect-all-face-zones
remeshes all the intersecting face zones.
After the intersect operation, remesh is called automatically. To disable the post-remesh operation,
use the text command:
/boundary/remesh/controls/intersect/remesh-post-intersection? no
intersect-face-zones
remeshes two intersecting face zones so that they become conformal.
After the intersect operation, remesh is called automatically. To disable the post-remesh operation,
join-all-face-zones
connects all overlapping face zones using the join operation.
After the join operation, remesh is called automatically. To disable the post-remesh operation,
join-face-zones
connects two overlapping faces.
After the join operation, remesh is called automatically. To disable the post-remesh operation,
mark-intersecting-faces
highlights the triangles in the neighborhood of the line of intersection.
mark-join-faces
highlights the triangles in the neighborhood of the join edge loop.
mark-stitch-faces
highlights the triangles in the neighborhood of the stitch edge loop.
remesh-face-zone
remeshes a specified face zone by automatically extracting edge loops. If edge loops are present in
the current domain (for example, if they were created using the create-edge-loops command),
they are used to remesh the specified face zone.
remesh-constant-size
remeshes the specified face zones to a constant triangle size while maintaining conformity with adjacent
zones. Specify the boundary face zones to be remeshed, the boundary edge zones, feature angle,
corner angle, and the constant size. Additionally, specify whether the current boundary face zones
should be replaced by the remeshed face zones after the operation is complete.
remesh-face-zones-conformally
remeshes face zones using the current size function and keeping a conformal interface between them.
If no size function is defined, an error message will be generated.
This command will prompt for:
• Boundary Face Zones
• Boundary Edge Zones
• feature angle – used to determine the minimum angle between features that will be
preserved during remeshing
• corner angle – used to specify the minimum angle between feature edges that will be
preserved
• Replace Face Zone? – (default is Yes) the remeshed face zone(s) will take the name and
-id of the original zones, and the original face zone(s) will have “orig” appended to their name.
If No, the remeshed face zone(s) will have “retri” added postfix.
Note:
Periodic face zones cannot be remeshed using this command.
remesh-overlapping-zones
remeshes overlapping face zones. The non-overlapping region is remeshed using the edge loops created
from the overlapping face zones.
size-functions
enters the size functions menu where you can define size functions for controlling mesh size distribution.
compute
computes the size field based on the defined parameters.
contours/
contains options for displaying contours of size functions.
draw
displays contours in the graphics window. Compute the size field using /size-func-
tions/compute or read in a size field file prior to displaying the contours of size.
set/refine-facets?
enables you to specify smaller facets if the original are too large. Default is no.
create
defines the size function based on the specified parameters.
create-defaults
creates default size functions based on face and edge curvature and proximity.
delete
deletes the specified size function or the current size field.
boundary/
delete-all
deletes all the defined size functions.
disable-periodicity-filter
removes periodicity from the size field.
list
lists all the defined size functions and the parameter values defined.
reset-global-controls
resets the global controls to their default values.
set-global-controls
sets the values for the global minimum and maximum size, and the growth rate.
set-periodicity-filter
applies periodicity to the size field by selecting one source face zone.
Note:
Ensure that periodicity is previously defined.
Only rotational periodicity is supported, translational periodicity is not supported

currently.
set-prox-gap-tolerance
sets the tolerance relative to minimum size to take gaps into account. Gaps whose thickness is less
than the global minimum size multiplied by this factor will not be regarded as a proximity gap.
set-scaling-filter
specifies the scale factor, and minimum and maximum size values to filter the size output from
the size field.
triangulate-quad-faces?
identifies the zones comprising non-triangular elements and uses a triangulated copy of these
zones for computing the size functions.
use-cad-imported-curvature?
enables/disables curvature data from the nodes of the CAD facets.
stitch-all-face-zones
connects (stitches) all the face zones along the free edges.
After the stitch operation, remesh is called automatically. To disable the post-remesh operation,
stitch-face-zones
connects two surfaces along their free edges.
stitch-with-preserve-boundary
connects (stitches) a zone to another which is connected to an existing volume mesh, while preserving
the boundary of the zones connected to the volume mesh. Specify a list of boundary zones to be
preserved, a list of the boundary zones to be connected to each of these zones, and the tolerance
value.
Note:
This command will not work for overlapping or partially overlapping face zones.
triangulate
triangulates quad zones.
reset-element-type
resets the element type (mixed, tri, or quad) of a boundary zone. If you have separated a mixed (tri and
quad) face zone into one tri face zone and one quad face zone, for example, each of these will be identified
as a “mixed" zone. Resetting the element type for each of these new zones will identify them as, respectively,
a triangular zone and a quadrilateral zone.
resolve-face-intersection
resolves self intersection on manifold surface meshes.
scale-nodes
applies a scaling factor to all node coordinates. You can use this command to change the units of the grid.
separate/
contains options for separating face zones.
local-regions
define
enables you to define the local region.
delete
deletes the specified local region.
init
list-all-regions
lists all the local regions defined.
mark-faces-in-region
marks the faces that are contained in a specified local refinement region.
boundary/
sep-face-zone-by-angle
separates a boundary face zone based on significant angle.
sep-face-zone-by-cnbor
separates a boundary/interior face zone based on its cell neighbors.
sep-face-zone-by-mark
separates a boundary face zone by moving marked faces to a new zone.
sep-face-zone-by-region
separates a boundary face zone based on contiguous regions.
sep-face-zone-by-seed
separates a boundary face zone by defining a seed face on the surface.
sep-face-zone-by-seed-angle
separates faces connected to the seed face, whose normal fall within the specified cone.
sep-face-zone-by-shape
separates a boundary face zone based on the shape of the faces (triangular or quadrilateral).
set-periodicity
defines the periodicity parameters. You will be prompted for the type of periodicity (rotational or
translational). For rotational periodicity, you will be prompted for the angle and axis of rotation
parameters. For translational periodicity, you will be prompted for the shift vector components.
slit-boundary-face
slits a boundary face zone by duplicating all faces and nodes, except those nodes that are located at the
edges of the boundary zone. A displacement can be specified to provide thickness to the boundary. The
slit command only works when it is possible to move from face to face using the connectivity provided by
the cells.
You should slit the boundary face after you generate the volume mesh so that cells will not be
placed inside the gap. There may be some inaccuracies when you graphically display solution data
for a mesh with a slit boundary in ANSYS Fluent.
smooth-marked-faces
smooths the marked faces.
unmark-selected-faces
unmarks the marked selected faces.
wrapper/
enters the surface wrapper menu.
Note:
This menu is no longer supported, and will be removed in a future release.
delete-all-cells?
deletes the Cartesian mesh. This command is available only after initializing the Cartesian grid.
imprint-edges?
imprints the wrapper surface on recovered feature edges that you recover. This command is available
only after creating the wrapper surface.
initialize
creates a Cartesian mesh of the specified parameters.
local-regions/
define
enables you to define the local refinement region.
delete
deletes the specified refinement region.
init
list-all-regions
lists all the refinement regions in the console.
refine
refines the specified region according to the refinement parameters specified.
post-improve
enters the wrapper surface improvement options menu.
auto-post-improve
improves the wrapper surface using a pre-defined sequence of operations.
auto-post-wrap
performs a pre-defined sequence of post-wrapping operations on the wrapper surface.
coarsen-wrapper-surf
coarsens the wrapper surface.
filterout-far-features
deletes feature edges beyond the specified distance from the wrapper surface.
imprint-geom-surf
imprints the geometry threads on wrapper (manual zone recovery).
improve
improves the wrapper surface quality based on skewness, size change, or aspect ratio.
inflate-thin-regions
pushes apart the overlapping faces in thin regions.
post-single-surface
cleans up unmerged island regions after recovering the single surface.
recover-single-surface
recovers thin surfaces as a single surface after wrapping.
boundary/
recover-zone
separates the wrapper surface into zones based on the original geometry.
remove-crossover-config
removes crossover configurations.
remove-duplicated-nodes
removes the duplicate nodes on the wrapper surface.
rename-wrapper-zones
renames the wrapper zones by specifying an appropriate prefix instead of the default prefix (wrap-).
resolve-nonmanifoldness
resolves non-manifold configurations on the wrapper surface.
resolve-self-intersection
removes the self intersecting faces.
rezone
smooths the zones separated from the wrapper surface for better representation of the geometry.
smooth-folded-faces
smooths the folded faces on the wrapper surface.
smooth-wrapper-surf
smooths the wrapper surface.
swap-wrapper-surf
swaps the nodes of the wrapper surface to improve its quality.
pre-smooth?
enables/disables smoothing of nodes during wrapping. This command is available only after initializing
the Cartesian grid.
region/
enters the regions menu. This command is available only after initializing the Cartesian grid.
draw-holes
draws the holes detected.
delete-interface
deletes the existing interface.
extract-enclosing-region
extracts the interface for the region enclosing the specified point.
extract-interface
extracts the interfaces for the specified regions.
fix-holes
fixes the specified hole(s).
list-holes
lists the existing holes.
list-interfaces
lists the existing interfaces.
list-regions
lists the regions created during the wrapper initialization.
merge-interior-regions
merges all the interior regions. After using this command, two regions will remain, the exterior
and the merged interior region.
merge-regions
merges the specified regions.
modify-region-holes
enables you to fix or open holes related to the specified region.
open-holes
opens the specified hole(s).
refine
refines the Cartesian grid based on the zone specific sizes and local size functions. This command
is available only after initializing Cartesian grid.
refine-enclosing-region
refines the region enclosing the specified point.
refine-region
refines the specified region.
refine-zone-cells
refines the cells associated with the specified boundary zone. This command is available only after
initializing the Cartesian grid.
update-regions
updates the regions to account for the changes made to the original geometry (during manual
hole fixing).
wrap-enclosing-region
generates the wrapper surface for the region enclosing the specified point.
wrap-interface
generates the wrapper surface for the specified interface.
wrap-region
generates the wrapper surface for the specified region. This command is available only after initial-
izing the Cartesian grid.
wrapper-region-at-location
reports the region at the specified location.
set/
enters the menu to set cell parameters.
auto-draw-sizes
enables you to draw zone-specific sizes.
boundary/
clear-size
clears all the zone specific size parameters.
curvature-factor
enables you to modify curvature size function sensitivity of a wrapper.
curvature?
enables you to enable or disable curvature size function.
default-face-size
enables you to specify default face size for Cartesian grid.
feature-threshold
enables you to specify critical range within which the nodes of the wrapper will be projected onto
the feature edges.
ignore-feature-skewness
specifies the critical skewness to be considered for ignoring feature lines.
ignore-self-proximity?
enables/disables the self-proximity calculation during the refinement.
list-size
lists the current zone specific sizes of the domain.
local-size-function
enables you to set local size functions.
max-refine-level
specifies the maximum refinement level permitted.
maximum-size-level
specifies the refinement level of the largest cell in the Cartesian grid.
minimum-proximity-gap
specifies the minimum proximity gap within which the proximity will be ignored.
minimum-size-level
specifies the refinement level of the smallest cell in the Cartesian grid.
number-of-size-boxes
controls the number of boxes to display, when using Draw Sizes button in the Face Size tab.
proximity-factor
enables you to modify proximity size function sensitivity of a wrapper.
proximity?
enables/disables proximity size function.
read-local-sizes
reads the zone specific sizes stated in a file.
refinement-buffer-layers
specifies the number of additional cell layers that you want to refine.
relative-island-count
specifies a critical cell count of noise zones in a zone separation.
volume-marker
offers a volume marker manipulation for holes.
write-local-sizes
writes the zone specific sizes in a file.
zone-specific-size
enables you to specify zone specific sizes.
Chapter 2: cad-assemblies/
add-prefix
enables you to add a prefix to the selected entities. Specify the path for the entities and the prefix to be
added.
add-to-object
enables you to add the selected CAD entities to an existing object. Specify the path for the entities to be
added and select the object to be modified.
create-objects
enables you to create new geometry/mesh objects for the selected entities. Specify the path for the entities
and if required, choose to create one object per CAD entity selected and/or retain the CAD zone granularity
for object creation. By default, a single object will be created for all entities selected and the CAD zone
granularity will not be retained. Specify the object name (if applicable), object type (geom or mesh), and
cell zone type (dead, fluid, or solid).
delete-cad-assemblies
deletes all the CAD assemblies data.
draw
displays the selected CAD entities.
draw-options/
contains additional options for displaying CAD entities.
add-to-graphics
adds the selected entities to the display in the graphics window.
draw-unlabelled-zones
displays the unlabeled zones for the selected entities in the graphics window.
remove-from-graphics
removes the selected entities from the display in the graphics window.
extract-edge-zones
enables you to extract the feature edge zone for the selected entities. Specify the path for the CAD entities
and the feature angle.
labels/
contains options for displaying and managing labels.
add-to-graphics
adds the selected labels to the display in the graphics window.
delete
deletes the selected labels.
cad-assemblies/
draw
displays the selected labels.
remove-from-graphics
removes the selected labels from the display in the graphics window.
rename
enables you to rename the selected labels. Specify the path for the labels and the new name. For
multiple selections, the specified name will be used, with a suitable index as suffix. For example, spe-
cifying a new label name wall will result in entities wall.1, wall.2, etc.
manage-state/
contains options for setting the CAD entity state.
suppress
suppresses the selected CAD entities.
unlock
unlocks the selected CAD entities.
unsuppress
unsuppresses the selected CAD entities.
rename
enables you to rename the selected entities. Specify the path for the entities and the new name. For multiple
entities, the specified name will be used, with a suitable index as suffix. For example, specifying a new
name wall will result in entities wall.1, wall.2, etc.
replace-object
enables you to replace an object with the selected CAD entities. Specify the path for the entities to be
added and select the object to be modified.
update-cad-assemblies
reimports the selected CAD entities using new parameters specified in the update-options/ menu.
update-options/
contains options for updating the CAD entities on reimport.
import-edge-zones?
enables you to import edge zones from the CAD entities on reimport. Specify an appropriate value for
feature angle.
one-object-per
enables you to change the CAD object granularity on reimport.
one-zone-per
enables you to change the CAD zone granularity on reimport.
tessellation
enables you to control the tessellation (faceting) during reimport. You can select either cad-faceting
or cfd-surface-mesh.
CAD faceting enables you to control the tessellation based on the CAD faceting tolerance and
maximum facet size specified.
CFD Surface Mesh enables you to use a size field file during reimport. If you enter yes, specify
the size field file to be read. If you do not want to use a size field file, you can obtain conformal
faceting based on the underlying curve and surface curvature (using the minimum and maximum
facet sizes, and the facet curvature normal angle specified) and edge proximity (using the cells
per gap specified). You can also save the size field in a file (size field is computed based on the
specified parameters; that is, Min Size, Max Size, Curvature Normal Angle, Cells Per Gap).
Chapter 3: diagnostics/
face-connectivity/
contains options for fixing problems with face connectivity on the specified object face zones or boundary
face zones.
add-label-to-small-neighbors
separates island object face zones from all connected neighbors and merges them to the connected
neighboring face zone label based on minimum face count specified.
fix-deviations
fixes deviations in the wrapped surface mesh by imprinting edges on the wrapped face zones. Specify
the number of imprint iterations and aggressive imprint iterations to be performed.
fix-duplicate-faces
removes duplicate faces.
fix-free-faces
removes free faces by the method selected. The methods available are:
delete-free-edge-faces
removes free faces having the specified number of free edges.
delete-fringes
removes free face fringes based on the face count specified.
delete-skewed-faces
removes free faces based on the minimum skewness specified.
merge-nodes
removes free faces by merging nodes within the tolerance specified.
stitch
removes free faces based on the tolerance and number of steps specified.
fix-invalid-normals
fixes invalid normals by smoothing.
Note:
Zone-specific or scoped prism settings should be applied prior to using this command.
fix-islands
deletes groups of island faces based on the absolute face count specified.
diagnostics/
fix-multi-faces
fixes multiply connected faces by a combination of deleting face fringes, overlapping faces, and dis-
connected faces. Specify the maximum number of fringe faces, overlapping faces, and multiply con-
nected edges, respectively.
fix-point-contacts
fixes non-manifold configurations by removing point contacts.
fix-self-intersections
fixes self intersecting or folded faces. For fixing folded faces by smoothing, specify whether features
should be imprinted.
fix-slivers
fixes faces based on skewness and height criteria. Height is the perpendicular distance between the
longest edge of the triangle and the opposite node.
fix-spikes
fixes spiked faces based on the spike angle specified.
fix-steps
fixes step configurations by smoothing or collapsing faces based on the angle and step width specified.
remove-label-from-small-neighbors
removes disconnected island object face zone labels by merging the specified island object face zones
to the connected neighboring face zone label based on minimum face count specified.
quality/
contains options for fixing problems related to surface mesh quality on the specified object face zones or
boundary face zones.
collapse
collapses bad quality faces based on area or skewness. For collapsing based on face area, specify the
maximum face area and relative maximum area. For collapsing based on face skewness, specify the
minimum skewness and feature angle. Additionally, specify the number of iterations and whether the
boundary should be preserved.
delaunay-swap
improves the surface mesh by swapping based on the minimum skewness value and feature angle
specified. Additionally, specify the number of iterations and whether the boundary should be preserved.
general-improve
improves the surface mesh based on aspect ratio, size change, or skewness. Specify the minimum
quality value, feature angle, number of iterations, and whether the boundary should be preserved.
smooth
improves the surface mesh by smoothing. Specify the number of smoothing iterations and whether
the boundary should be preserved.
Chapter 4: display/
all-grid
displays the grid according to the currently set parameters.
annotate
adds annotation text to a graphics window. It will prompt you for a string to use as the annotation text,
and then a dialog box will prompt you to select a screen location using the mouse-probe button on your
mouse.
boundary-cells
displays boundary cells attached to the specified face zones.
boundary-grid
displays only boundary zones according to the currently set parameters.
center-view-on
sets the camera target to be the center (centroid) of an entity.
clear
clears the active graphics window. This option is useful when you redo an overlay.
clear-annotation
removes all annotations and attachment lines from the active graphics window.
draw-cells-using-faces
draws cells that are neighbors for the selected faces.
draw-cells-using-nodes
draws cells that are connected to the selected nodes.
draw-face-zones-using-entities
draws cells that are connected to the selected entities.
draw-zones
draws the boundary/cell zones using the zone ID specified as input.
objects/
contains commands for displaying objects.
display-neighborhood
displays the objects that are in the neighborhood of the selected object. The neighboring objects have
to be in contact, or intersecting the selected object.
display-similar-area
displays the objects with similar area to the selected object area.
display/
explode
explodes the objects in the geometry. (This command is valid only when the geometry is an assembled
mode.)
hide-objects
hides the selected objects in the display.
implode
implodes or assembles the objects in the geometry. (This command is available only when the geometry
is an exploded mode.)
isolate-objects
displays only the selected objects.
make-transparent
makes the geometry transparent so that internal objects are visible. This command works as a toggle
undoing the transparency of the previously selected objects.
select-all-visible
selects all the visible objects in the graphics window.
show-all
unhides all the objects in the geometry and displays them.
toggle-color-mode
toggles the colors of the geometry. In one mode geometry is colored object-wise while in the other
mode it is colored zone-wise.
toggle-color-palette
toggles the color palette of the geometry.
redisplay
redraws the grid in the graphics window.
save-picture
saves a picture file of the active graphics window.
set-grid/
contains options controlling the display of the grid.
all-cells?
enables/disables the display of all cells.
all-faces?
enables/disables the display of all faces.
all-nodes?
enables/disables the display of all nodes.
cell-quality
sets the lower and upper bounds of quality for cells to be displayed. Only cells with a quality measure
value (for example, skewness) within the specified range will be displayed.
default
resets the grid display parameters to their default values.
face-quality
sets the lower and upper bounds of quality for faces to be displayed. Only faces with a quality measure
value (for example, skewness) within the specified range will be displayed.
free?
enables/disables the drawing of faces/nodes that have no neighboring face on at least one edge.
label-alignment
sets the alignment of labels that appear in the graphics window. By default, the label is centered on
the node, cell, and so on, to which the label refers. You can specify *,ˆ, v, <, > for center, top,
bottom, left, or right. You can also combine symbols—for example, "*v" for bottom center.
label-font
sets the label font. By default, all labels appear in “sans serif" font. Some other choices are roman,
typewriter, and stroked.
label-scale
scales the size of the label.
labels?
enables/disables the display of labels.
left-handed?
enables/disables the display of left-handed faces.
list
lists all the grid display settings.
marked?
enables/disables the display of marked nodes.
multi?
enables/disables the display of those faces/nodes that have more than one neighboring face on an
edge.
neighborhood
sets the x, y, and z range to be within a specified neighborhood of a specified grid object.
node-size
sets the node symbol scaling factor.
node-symbol
specifies the node symbol.
normal-scale
sets the scale factor for face normals.
normals?
enables/disables the display of face normals.
refine?
enables/disables the display of those faces that have been marked for refinement.
tagged?
enables/disables the display of tagged nodes.
display/
unmeshed?
enables/disables the display of nodes and faces that have not been meshed.
unused?
enables/disables the display of unused nodes.
x-range
limits the display of grid objects to the specified x-range.
y-range
limits the display of grid objects to the specified y-range.
z-range
limits the display of grid objects to the specified z-range.
set-list-tree-separator
sets the separator character to be used to determine the common prefix for items listed in the selection
lists, when the tree view is used.
set/
Enables you to enter the set menu to set the display parameters.
colors/
enables you to enter the colors options menu.
axis-faces
sets the color of axisymmetric faces.
background
sets the background (window) color.
color-by-type?
enables you to specify that the entities should be colored by their type or ID.
color-by-partition?
enables you to view the partitions by color. This command applies to parallel processing.
far-field-faces
sets the color of far field faces.
foreground
sets the foreground (text and window frame) color.
free-surface-faces
sets the color of free surface faces.
graphics-color-theme
Sets the color theme for the graphics window. The color options (black, white, gray-gradient,
or workbench) are for the background display, but changing the theme also changes the default
colors for items that display in the graphics windows, like faces and edges.
highlight-color
sets the highlight color.
inlet-faces
sets the color of the inlet faces.
interface-faces
sets the color of grid interface faces.
interior-faces
sets the color of the interior faces.
internal-faces
sets the color of the internal interface faces.
list
lists the colors available for the selected zone type.
outlet-faces
sets the color of the outlet faces.
overset-faces
sets the color of the overset faces.
periodic-faces
sets the color of periodic faces.
rans-les-interface-faces
sets the color of RANS/LES interface faces.
reset-colors
resets the individual grid surface colors to the defaults.
reset-user-colors
resets individual grid surface colors to the defaults.
show-user-colors
lists the current defined user colors.
skip-label
sets the number of labels to be skipped in the colormap scale.
surface
sets the color of surfaces.
symmetry-faces
sets the color of symmetric faces.
traction-faces
sets the color for traction faces.
user-color
enables you to change the color for the specified zone.
wall-faces
sets color for wall faces.
display/
edges?
enables/disables the display of face/cell edges.
filled-grid?
enables/disables the filled grid option. When a grid is not filled, only its outline is drawn.
lights/
enters the lights menu.
headlight-on?
turns the light that moves with the camera on or off. This is controlled automatically by default.
lighting-interpolation
sets the lighting interpolation method to be used. You can choose automatic, flat, gouraud,
or phong. "Automatic" automatically picks the best lighting method for the display in the graphics
window. Flat is the most basic method, and the others are more sophisticated and provide
smoother gradations of color.
lights-on?
enables/disables the display of all lights.
set-ambient-color
sets the ambient color for the scene. The ambient color is the background light color in scene.
set-light
adds or modifies a directional, colored light.
line-weight
sets the line width factor for the window.
mouse-buttons
prompts you to select a function for each of the mouse buttons.
native-display-defaults
resets graphics window parameters to optimal settings for a local display.
Used after setting parameters for a remote display with remote-display-defaults.
overlays?
turns overlays on and off.
picture/
saves a hardcopy file of the active graphics window.
color-mode/
contains the available color modes.
color
selects full color and plots the hardcopy in color.
gray-scale
selects gray scale (i.e., various shades of gray) and converts color to gray-scale for hardcopy.
list
displays the current hardcopy color mode.
mono-chrome
selects color to monochrome (black and white) for hardcopy.
dpi
specifies the resolution in dots per inch for EPS and PostScript files.
driver/
contains the available hardcopy formats.
dump-window
sets the command to dump a graphics window to a file.
eps
sets the Encapsulated PostScript format.
jpeg
sets the JPEG image format.
list
displays the current hardcopy format.
options
enables you to set hardcopy options, such as landscape orientation, pen speed, and physical
size. The options may be entered on one line if you separate them with commas.
png
sets the PNG image format.
post-format/
contains commands for setting the PostScript driver format and save files in PS files that can
be printed quickly.
fast-raster
enables a raster file that may be larger than the standard raster file, but will print much
more quickly.
raster
enables the standard raster file.
rle-raster
enables a run-length encoded raster file that will be about the same size as the standard
raster file, but will print slightly more quickly. This is the default file type.
vector
enables the standard vector file.
post-script
sets the PostScript format.
ppm
sets the PPM format.
tiff
sets the TIFF format.
display/
vrml
sets the VRML format.
invert-background?
enables/disables the exchange of foreground/background colors for hardcopy files.
jpeg-hardcopy-quality
controls the size and quality of how JPEG files are saved based on a scale of 0-100, with zero being
low quality small files and 100 being high quality larger files.
landscape?
toggles between landscape or portrait orientation.
preview
applies the settings of the color-mode, invert-background, and landscape options to the currently
active graphics window to preview the appearance of printed hardcopies.
use-window-resolution?
disables/enables the use of the current graphics window resolution when saving an image of the
graphics window. If disabled, the resolution will be as specified for x-resolution and y-res-
olution.
x-resolution
sets the width of the raster format images in pixels (0 implies that the hardcopy should use the
same resolution as the active graphics window).
y-resolution
sets the height of the raster format images in pixels (0 implies that the hardcopy should use the
same resolution as the active graphics window).
re-render
re-renders the current window after modifying the variables in the set menu.
remote-display-defaults
adjusts graphics window parameters to optimal settings for a remote display.
Restore parameters for local display using native-display-defaults.
rendering-options/
contains the commands that enable you to set options that determine how the scene is rendered.
animation-option
enables you to specify the animation option as appropriate.
all
uses a solid-tone shading representation of all geometry during mouse manipulation.
wireframe
uses a wireframe representation of all geometry during mouse manipulation. This is the default
option.
auto-spin?
enables mouse view rotations to continue to spin the display after the button is released.
color-map-alignment
sets the color bar alignment.
device-info
prints out information about your graphics driver.
double-buffering?
enables or disables double buffering. Double buffering dramatically reduces screen flicker during
graphics updates. If your display hardware does not support double buffering and you turn this
option on, double buffering will be done in software. Software double buffering uses extra memory.
driver
Changes the current graphics driver. When enabling graphics display, you have various options:
for Linux, the available drivers include opengl and x11; for Windows, the available drivers include
opengl, dx11 (for DirectX 11), and msw (for Microsoft Windows). You can also disable the
graphics display window by entering null. For a comprehensive list of the drivers available to
you, press the Enter key at the driver> prompt.
Note:
For any session that displays graphics in a graphics window and/or saves picture
files, having the driver set to x11, msw, or null will cause the rendering / saving
speed to be significantly slower.
face-displacement
sets the face displacement (in Z-buffer units along the camera Z-axis) for the displayed geometry
when both faces and edges are displayed simultaneously.
help-text-color
sets the color of the help text on the screen. You can select black, default, or white.
hidden-lines?
turns hidden line removal on or off. This command is available only when the color scheme is set
to classic.
Note:
This command (only available when Graphics Color Theme is set to Black) is
deprecated and will be removed at a future release.
hidden-lines-method/
enables you to select the hidden line removal algorithm.
mesh-display-hlr?
enables you to remove hidden lines for surfaces that are very close together. This option should
be used only if the default algorithm does not produce suitable results.
display/
normal-hlr-algorithm
is the default hidden line removal algorithm.
Note:
These commands (only available when Graphics Color Theme is set to Black)
are deprecated and will be removed at a future release.
hidden-surface-method/
enables you to choose from among the hidden surface removal methods that are supported. These
options (listed below) are display hardware dependent.
hardware-z-buffer
is the fastest method if your hardware supports it. The accuracy and speed of this method is
hardware dependent.
painters
will show less edge-aliasing effects than hardware-z-buffer. This method is often used
instead of software-z-buffer when memory is limited.
software-z-buffer
is the fastest of the accurate software methods available (especially for complex scenes), but
it is memory intensive.
z-sort-only
is a fast software method, but it is not as accurate as software-z-buffer.
hidden-surfaces?
enables/disables the display of hidden surfaces.
outer-face-cull?
enables/disables the display of outer faces.
set-rendering-options
sets the rendering options.
surface-edge-visibility
controls whether or not the mesh edges are drawn.
reset-graphics
resets the graphics system.
shrink-factor
sets shrinkage of both faces and cells. A value of zero indicates no shrinkage, while a value of one
would shrink the face or cell to a point.
styles/
contains commands for setting the display style for the different types of nodes and faces that can be
displayed.
cell-quality
indicates cells within the specified cell quality range.
cell-size
indicates cells within the specified cell size range.
face-quality
indicates faces within the specified face quality range.
face-size
indicates faces within the specified face size range.
free
indicates free nodes or faces.
left-handed
indicates faces that do not follow the right-hand rule with respect to their cell neighbors.
mark
indicates marked objects (for expert users).
multi
indicates multiply-connected nodes or faces.
refine
indicates boundary faces to be refined.
tag
indicates tagged objects (for expert users).
unmeshed
indicates unmeshed nodes or faces.
unused
indicates unused nodes or faces.
title
sets the problem title.
windows/
enters the windows options menu, which contains commands that enable you to customize the relative
positions of sub-windows inside the active graphics window.
The menu structure for the axes, main, scale, text, video, and xy submenus is similar.
aspect-ratio
sets the aspect ratio of the active window.
axes/
enters the axes window options menu.
border?
sets whether or not to draw a border around the axes window.
bottom
sets the bottom boundary of the axes window.
display/
clear
sets the transparency of the axes window.
left
sets the left boundary of the axes window.
right
sets the right boundary of the axes window.
top
sets the top boundary of the axes window.
visible?
controls the visibility of the axes window.
main/
enters the main view window options menu.
border?
sets whether or not to draw a border around the main viewing window.
bottom
sets the bottom boundary of the main viewing window.
left
sets the left boundary of the main viewing window.
right
sets the right boundary of the main viewing window.
top
sets the top boundary of the main viewing window.
visible?
controls the visibility of the main viewing window.
scale/
enters the color scale window options menu.
border?
sets whether or not to draw a border around the color scale window.
bottom
sets the bottom boundary of the color scale window.
clear?
sets the transparency of the color scale window.
font-size
sets the font size of the color scale window.
format
sets the number format of the color scale window (for example, %0.2e).
left
sets the left boundary of the color scale window.
margin
sets the margin of the color scale window.
right
sets the right boundary of the color scale window.
top
sets the top boundary of the color scale window.
visible?
controls the visibility of the color scale window.
text
enters the text window options menu.
application?
shows or hides the application name in the picture.
border?
sets whether or not to draw a border around the text window.
bottom
sets the bottom boundary of the text window.
clear?
enables/disables the transparency of the text window.
company?
shows or hides the company name in the picture.
date?
shows or hides the date in the picture.
left
sets the left boundary of the text window.
right
sets the right boundary of the text window.
top
sets the top boundary of the text window.
visible?
controls the visibility of the text window.
video/
contains options for modifying a video. This menu is not relevant for the meshing mode.
background
sets the background color of the graphics window. The color is specified as a string of three
comma-separated numbers between 0 and 1, representing red, green, and blue. For example,
display/
to change the background from black (default) to gray, you would enter ".5,.5,.5" after selecting
the background command.
color-filter
sets the video color filter. For example, to change the color filter from its default setting to PAL
video with a saturation of 80% and a brightness of 90%, you would enter
"video=pal,sat=.8,gain=.9" after selecting the color-filter command.
foreground
sets the foreground (text) color of the graphics window. The color is specified as a string of
three comma-separated numbers between 0 and 1, representing red, green, and blue. For ex-
ample, to change the foreground from white (default) to gray, you would enter ".5,.5,.5" after
selecting the foreground command.
on?
enables or disables the video picture settings.
pixel-size
sets the window size in pixels.
xy/
enters the XY plot window options menu.
border?
sets whether or not to draw a border around the XY plot window.
bottom
sets the bottom boundary of the XY plot window.
left
sets the left boundary of the XY plot window.
right
sets the right boundary of the XY plot window.
top
sets the top boundary of the XY plot window.
visible?
controls the visibility of the XY plot window.
update-scene/
contains commands that enable you to update the scene description.
delete
deletes the geometry selected using the select-geometry command.
display
displays the geometry selected using the select-geometry command.
draw-frame?
enables/disables the drawing of the bounding frame.
overlays?
enables/disables the overlays option.
select-geometry
enables you to select the geometry to be updated.
set-frame
enables you to change the frame options.
transform
enables you to apply the transformation matrix to the geometry selected using the select-geometry
command.
views/
enters the view window options menu.
auto-scale
scales and centers the current scene without changing its orientation.
camera/
contains commands to set the camera options.
dolly-camera
enables you to move the camera left, right, up, down, in, and out.
field
enables you to set the field of view (width and height) of the scene.
orbit-camera
enables you to move the camera around the target. Gives the effect of circling around the target.
pan-camera
gives you the effect of sweeping the camera across the scene. The camera remains at its position
but its target changes.
position
sets the camera position.
projection
lets you switch between perspective and orthographic views.
roll-camera
lets you adjust the camera up-vector.
target
sets the point the camera will look at.
up-vector
sets the camera up-vector.
zoom-camera
adjusts the camera’s field of view. This operation is similar to dollying the camera in or out of the
scene. Dollying causes objects in front to move past you. Zooming changes the perspective effect
in the scene (and can be disconcerting).
default-view
resets the view to front and center.
display/
delete-view
deletes a particular view from the list of stored views.
last-view
returns to the camera position before the last manipulation.
list-views
lists all predefined and saved views.
read-views
reads views from an external view file.
restore-view
sets the current view to one of the stored views.
save-view
saves the currently displayed view into the list of stored views.
write-views
writes views to an external view file.
xy-plot/
enters the XY plot menu.
cell-distribution
plots a histogram of cell quality.
face-distribution
plots a histogram of face quality.
file
enables you to choose a file from which to create an xy plot.
set/
enters the set window options menu.
auto-scale?
sets the range for the x- and y-axis. If auto-scaling is not activated for a particular axis, you will be
prompted for the minimum and maximum data values.
background-color
sets the color of the field within the abscissa and ordinate axes.
file-lines
sets the parameters for plot lines.
file-markers
sets the parameters for data markers.
key
sets the visibility and title of the description box that displays the markers and/or lines with their
associated data. The key can be positioned and resized using the left mouse button.
labels
sets the strings that define the x- and y- axis labels.
lines
sets the pattern, weight, and color of the plot lines.
log?
enables/disables the log scaling on the x- and y-axis.
markers
sets parameters for the data markers.
numbers
sets the format and precision of the data numbers displayed on the x- and y-axis.
plot-to-file
enables you to write the xy plot values to a file.
rules
sets the visibility, line weight and color of the major and minor rules in the x- and y-axis directions.
windows
contains commands that enable you to customize the relative positions of sub-windows inside the
active graphics window.
border?
draws a border around the sub-window.
bottom
sets the bottom boundary of the sub-window.
left
sets the left boundary of the sub-window.
right
sets the right boundary of the sub-window.
top
sets the top boundary of the sub-window.
visible?
sets the visibility of the sub-window.
xy-percent-y?
enables/disables whether the y-coordinate should be scaled to show a percent of total values being
plotted.
zones/
contains commands for displaying zones.
display-neighborhood
displays the zones that are in the neighborhood of the selected zones. The neighboring zones have
to be in contact, or intersecting the selected zone.
display-similar-area
displays the zones with similar area to the selected zone area.
display/
hide-zones
hides the selected zones in the display.
isolate-zones
displays only the selected zones.
make-transparent
makes the geometry transparent so that internal zones are visible. This command works as a toggle
undoing the transparency of the previously selected zones.
select-all-visible
selects all the visible zones in the graphics window.
show-all
unhides all the zones in the geometry and displays them.
toggle-color-mode
toggles the colors of the geometry. In one mode geometry is colored object-wise while in the other
mode it is colored zone-wise.
toggle-color-palette
toggles the color palette of the geometry.
Chapter 5: exit
exit
exits the program.
Chapter 6: file/
The user interface commands related to the File menu (such as reading files, importing files) and other
Select File dialog boxes do not work for the dual process build. You need to use the TUI commands
instead (for example, /file/read-mesh).
Important:
• The host cannot be detached and reattached; once the connection is broken the data is lost. You
need to save the data if the machine must be shut down in between.
• All graphics information will be sent over the network, so initially it could take a long time to
assemble graphical information (especially if the host and remote server are across continents)
but after that the graphics manipulation is fast.
append-mesh
enables you to append the mesh files. This command is available only after a mesh file has been read in.
Append Rules:
• If zone names and IDs are duplicated, they will be modified and the changes will be reported in the
console.
• Domain information will be retained during the file append operation. If domain names are duplicated,
they will be modified and the changes will be reported in the console.
• Refinement region information will be retained during the file append operation. If region names are
duplicated, they will be modified and the changes will be reported in the console.
• You can append files comprising only edge zones (without face zones).
• Edge-face zone associations will be retained during the file append operation.
• Zone-specific prism parameter information will be retained during the file append operation.
append-meshes-by-tmerge
enables you to append the mesh files using the tmerge utility. This command is available only after a mesh
file has been read in.
cff-files?
Answering yes will set the Common Fluids Format (CFF) as the default file format for reading and writing
case/data files.
confirm-overwrite?
controls whether attempts to overwrite existing files require confirmation.
file/
If you do not want ANSYS Fluent to ask you for confirmation before it overwrites existing files, you
can enter the file/confirm-overwrite? text command and answer no.
file-format
enables/disables the writing of binary files.
filter-list
lists the names of the converters that are used to change foreign mesh (while importing mesh files from
third-party packages) files.
filter-options
enables you to change the extension (such as .cas, .msh, .neu) and arguments used with a specified filter.
For example, if you saved the PATRAN files with a .NEU extension instead of .neu, you can substitute
or add .NEU to the extension list. For some filters, one of the arguments will be the dimensionality
of the grid.
When you use the filter-options command for such a filter, you will see a default dimension-
ality argument of -d a. The dimension will automatically be determined, so you need not substitute
2 or 3 for a.
import/
enables you to import mesh information generated by some CAD packages (ANSYS, I-deas, NASTRAN,
PATRAN, and HYPERMESH), as well as mesh information in the CGNS (CFD general notation system) format.
These files are imported using the associated text commands listed here:
ansys-surf-mesh
enables you to read a ANSYS surface mesh file.
ansys-vol-mesh
enables you to read a ANSYS volume mesh file.
cad
enables you to import CAD files based on the options set.
• To import a single file (default), specify the file path and set up options for extracting features, im-
porting curvature data from CAD, and the length unit.
• To import multiple files, specify the directory path and pattern, and set up options for appending
the files, extracting features, importing curvature data from CAD and the length unit.
cad-geometry
enables you to import CAD files based on the options set.
• To import a single file (default), specify the file path. Set up options for the length unit, tessellation
method, and sizing parameters based on the tessellation method.
• To import multiple files, specify the directory path and pattern. Set up options for appending the
files, the length unit, tessellation method, and sizing parameters based on the tessellation method.
cad-options/
contains additional options for importing CAD files.
continue-on-error?
enables you to continue the import of the CAD file(s), despite errors or problems creating the fa-
ceting on certain surfaces, or other issues. This option is disabled by default.
create-cad-assemblies?
enables creating the CAD Assemblies tree on CAD import. The CAD Assemblies tree represents
the CAD tree as it is presented in the CAD package in which it was created. All sub-assembly levels
from the CAD are maintained on import in Fluent Meshing.
For commands specific to the CAD assemblies, refer to cad-assemblies/ (p. 47)
derive-zone-name-from-object-scope?
enables zones without Named Selections to inherit the object name on import. This option is dis-
abled by default.
double-connected-face-label
adds the specified label to the name of double-connected face zones (face zones shared by two
bodies).
enclosure-symm-processing?
enables processing of enclosure and symmetry named selections during import. This option is
disabled by default. This option is applicable only to ANSYS DesignModeler (*.agdb) files.
extract-features?
enables feature extraction from the CAD model on import. You can choose to disable this, if desired.
Specify an appropriate value for feature angle. The default value is 40.
import-body-names?
enables import of Body names from the CAD files. This option is enabled by default.
Note:
Any renaming of Body names in ANSYS Mechanical/ANSYS Meshing prior to the

export of the mechdat/meshdat files is ignored during import. Only original Body
names will be imported.
import-curvature-data-from-CAD?
enables importing of the curvature data from the nodes of the CAD facets. You can choose to disable
this, if desired.
import-part-names?
enables import of Part names from the CAD file(s). This option is enabled by default.
Note:
Any renaming of Part names in ANSYS Mechanical/ANSYS Meshing prior to the

export of the mechdat/meshdat files is ignored during import. Only original Part
names will be imported.
file/
merge-nodes?
enables the merging of geometry object nodes during CAD import. This option is enabled by default.
Note:
This option can be optionally enabled/disabled only when geometry objects are
imported using the CAD Faceting option for CAD import. Mesh object nodes
will always be merged when the CFD Surface Mesh is selected for CAD import.
modify-all-duplicate-names?
enables you to modify all duplicate object/zone names by adding incremental integers as suffix.
This option is disabled by default.
For example: The CAD file contains multiple parts (or bodies) named heatshield.
• With the option disabled (default), the imported zones will be named heatshield, heatshield.1,
heatshield.2, etc.
• With the option enabled, the imported zones will be named heatshield.1, heatshield.2, heat-
shield.3, etc.
name-separator-character
allows you to specify the character used between name fields. Default is ':'.
named-selections
enables you to import Named Selections from the CAD file(s), including Named Selections from
ANSYS DesignModeler, publications from CATIA, and so on. You can additionally choose to ignore
import of certain Named Selections based on the pattern specified (for example, Layer* to ignore
layer Named Selections from CATIA), or by specifying multiple wild cards (for example, ^(Col-
or|Layer|Material).* to remove color, layer, and material Named Selections from CATIA).
Note:
• Named Selections defined in ANSYS Meshing cannot be imported.
• If Named Selections is enabled, then Face named selections will be imported as face
zone labels.
object-type
enables the setting of object type on import. The options available are auto, geometry, and
mesh. The default setting is auto based on the tessellation method selected: geometry objects
will be created when the cad-faceting method is used, while mesh objects will be created
when the cfd-surface-mesh method is used.
one-face-zone-per
enables you to create one face zone per body/face/object to be imported.
one-object-per
enables you to create one object per body/part/file/selection to be imported. The default
program-controlled option allows the software to make the appropriate choice. This
option makes a choice between per body and per part based on whether shared topology
is off or on, respectively.
Note:
For ANSYS ICEM CFD files (*.tin), set the object granularity to one object per se-
lection.
read-all-cad-in-subdirectories?
when enabled, all files in the specified directory as well as in its subdirectories will be imported.
This option is disabled by default.
save-PMDB?
saves a PMDB (*.pmdb) file in the directory containing the CAD files imported. You can use this
file to import the same CAD file(s) again with different options set, for a quicker import than the
full import. This option is disabled by default.
Note:
Some options will not be available any more once the model is imported from
a PMDB file (for example, enclosure-symm-processing?), since they are
processed before the PMDB file is created.
separate-features-by-type?
enables separation of feature edges based on angle, connectivity, and named selections on import.
Edge zone names will have suitable suffixes depending on separation criteria, order of zones, ex-
isting zone names and other import options selected.
single-connected-edge-label
adds the specified label to the name of single-connected edge zones (edge zones referenced by
a single face).
strip-file-name-extension-from-naming?
removes the extension of the CAD files from the object/face zone names on import. This option is
disabled by default.
strip-path-prefix-from-names?
enables you to remove the path prefix from the object/face zone names on import. The default
setting is auto which removes the path prefix from object/face zone names when the object cre-
ation granularity is set to one object per file. You can also explicitly select yes or no.
tessellation
enables you to control the tessellation (faceting) during file import. You can select either cad-
faceting or cfd-surface-mesh.
CAD faceting enables you to control the tessellation based on the CAD faceting tolerance
and maximum facet size specified.
CFD Surface Mesh enables you to use a size field file, (Use size field file?). If you
enter yes, specify the size field file to be read. If you do not want to use a size field file,
you can obtain conformal faceting based on the underlying curve and surface curvature
(using the minimum and maximum facet sizes, and the facet curvature normal angle specified)
file/
and edge proximity (using the cells per gap specified). You can also save a size field in a file
(size field is computed based on the specified parameters; that is, Min Size, Max Size,
Curvature Normal Angle, Cells Per Gap).
use-collection-names?
enables you to use the Named Selections for the object/zone names on import. Select auto, no,
or yes. The default selection is auto where the Named Selection will be used as the object/zone
name, except when the object creation granularity is set to one object per file.
use-component-names?
enables you to add the component (part or assembly) names to the object/zone names on import.
Select auto, no, or yes. The default selection is auto where the component name will be added
to the object/zone name.
use-part-names?
enables you to choose whether to add the part names from the CAD file to the object and zone
names on import. The default setting is auto which adds the part names to both object and zone
names when object creation granularity is set to body. When the object creation granularity is set
to part or file, the part names are not added to the zone names, face zone labels, or the region
names, by default. You can also explicitly select yes or no.
use-part-or-body-names-as suffix-to-named-selections?
enables you to modify zone names by using part or body names as suffixes to the Named Selections
spanning multiple parts/bodies. This option is enabled by default.
For example: The CAD file contains a Named Selection effusion with part (or body) names
id_liner and od_liner.
• With the option enabled (default), the imported zones will be named effusion:id_liner and ef-
fusion:od_liner.
• With the option disabled, the imported zones will be named effusion.1 and effusion.2.
cgns-surf-mesh
enables you to read a CGNS surface mesh file.
cgns-vol-mesh
enables you to read a CGNS volume mesh file.
fidap-surf-mesh
enables you to read a FIDAP surface mesh file.
fidap-vol-mesh
enables you to read a FIDAP volume mesh file.
fl-uns2-mesh
enables you to read a Fluent UNS V2 case file.
fluent-2d-mesh
enables you to read a 2D mesh into the 3D version.
gambit-surf-mesh
enables you to read a GAMBIT surface mesh file.
gambit-vol-mesh
enables you to read a GAMBIT volume mesh file.
hypermesh-surf-mesh
enables you to read a HYPERMESH surface mesh file.
hypermesh-vol-mesh
enables you to read a HYPERMESH volume mesh file.
ideas-surf-mesh
enables you to read an I-deas surface mesh file.
ideas-vol-mesh
enables you to read an I-deas volume mesh file.
nastran-surf-mesh
enables you to read a NASTRAN surface mesh file.
nastran-vol-mesh
enables you to read a NASTRAN volume mesh file.
patran-surf-mesh
enables you to read a PATRAN surface mesh file.
patran-vol-mesh
enables you to read a PATRAN volume mesh file.
load-act-tool
loads the ANSYS ACT tool.
read-boundary-mesh
enables you to read a boundary mesh. If the boundary mesh is contained in two or more separate files,
you can read them in together and assemble the complete boundary mesh.
This option is also convenient if you want to reuse the boundary mesh from a file containing a large
volume mesh.
Note:
The naming of face zones can be controlled by Named Selections defined in ANSYS
Workbench. For details on exporting faceted geometry from ANSYS Workbench, refer to
the ANSYS Workbench Help.
read-case
enables you to read the mesh contained in a case file.
Note:
Cell hierarchy in case files adapted in the solution mode will be lost when they are read
in the meshing mode.
file/
Case files containing polyhedral cells can also be read in the meshing mode of Fluent. You can
display the polyhedral mesh, perform certain mesh manipulation operations, check the mesh quality,
and so on.
read-domains
enables you to read domain files.
Each mesh file written by Fluent has a domain section. A domain file is the domain section of the
mesh file and is written as a separate file. It contains a list of node, face, and cell zone IDs that make
up each domain in the mesh.
If a domain that is being read already exists in the mesh, a warning message is displayed. Fluent
verifies if the zones defining the domains exist in the mesh. If not, it will display a warning message.
read-journal
enables you to read a journal file into the program.
The read-journal command always loads the file in the main (that is, top-level) menu, regardless
of where you are in the menu hierarchy when you invoke it.
read-mesh
enables you to read a mesh file. You can also use this command to read a Fluent mesh file created with
GAMBIT, or to read the mesh available in a Fluent case file.
Note:
Reading a case file as a mesh file will result in loss of boundary condition data as the
mesh file does not contain any information on boundary conditions.
Case files containing polyhedral cells can also be read in the meshing mode of Fluent. You can
display the polyhedral mesh, perform certain mesh manipulation operations, check the mesh quality,
and so on.
Important:
You cannot read meshes from solvers that have been adapted using hanging nodes. To
read one of these meshes in the meshing mode in Fluent, coarsen the mesh within the
solver until you have recovered the original unadapted grid.
Note:
The naming of face zones can be controlled by Named Selections defined in ANSYS
Workbench. For details on exporting faceted geometry from ANSYS Workbench, refer to
the ANSYS Workbench Help.
read-meshes-by-tmerge
uses the tmerge utility to read the mesh contained in two or more separate files. It enables you to read
the mesh files together and helps assemble the complete mesh.
read-multi-bound-mesh
enables you to read multiple boundary mesh files into the meshing mode.
read-multiple-mesh
enables you to read in two or more files together and have the complete mesh assembled for you, if the
mesh files are contained in two or more separate files.
For example, if you are going to create a hybrid mesh by reading in a triangular boundary mesh
and a volume mesh consisting of hexahedral cells, you can read both files at the same time using
this command.
read-options
enables you to set the following options for reading mesh files:
• Enforce mesh topology: This option is disabled by default. Enabling this option will orient the face zones
consistently when the mesh file is read. If necessary, the zones being read will be separated, such that
each boundary face zone has at most two cell zones as neighbors, one on either side. Also, internal face
zones are inserted between neighboring cell zones that are connected by interior faces.
• Check read data: This option enables additional checks for the validity of the mesh. Enabling this option
will check the mesh topology during file read. In case incorrect mesh topology is encountered, warning
messages will be displayed and the erroneous entities will be deleted. Note that in case of mesh topology
errors, no automatic mesh repair is done, and that parts of the mesh may be non-conformal, contain
voids, or be erroneous in other ways. The purpose of the check-read-data option is to enable access
to corrupt files. This option is disabled by default with the assumption that correct data will be read,
and to shorten file read times.
read-size-field
enables you to read in a size field file.
Note:
If you read a size-field file after scaling the model, ensure that the size-field file is appro-
priate for the scaled model (size-field vertices should match the scaled model).
set-idle-timeout
Allows you to set an idle timeout so that an idle ANSYS Fluent session will automatically save and close
after the specified time.
set-tui-version
Allows you to improve backwards compatibility for journal files. This command hides any new TUI prompts
that are added at a future release of ANSYS Fluent and reverts to the arguments of the release that you
specify using the command (within two full releases of the current release). The command is automatically
added to a journal file as soon as you start the recording. See Creating and Reading Journal Files for details.
show-configuration
displays the current release and version information.
start-journal
starts recording all input and writes it to a file. The current Fluent version is automatically recorded in the
journal file. Note that commands entered using paths from older versions of Fluent will be upgraded to
their current path in the journal file. See Creating and Reading Journal Files in the Fluent User's Guide.
file/
To start the journaling process use the file/start-journal command, and end it with the
file/stop-journal command (or by exiting the program). To read a journal file into the program,
use the file/read-journal command.
Note:
The read-journal command always loads the file in the main (that is, top-level) menu,
regardless of where you are in the menu hierarchy when you invoke it.
The standard period (.) alias is the same as the file/read-journal definition and is defined
by:
(alias ’. (lambda () (ti-read-journal)))
start-transcript
starts recording input and output in a file.
A transcript file contains a complete record of all standard input to and output from Fluent (usually
all keyboard and user interface input and all screen output).Start the transcription process with the
file/start-transcript command, and end it with the file/stop- transcript command
(or by exiting the program).
stop-journal
stops recording input and closes the journal file.
stop-transcript
stops recording input and output, and closes the transcript file.
write-boundaries
enables you to write the specified boundaries into a mesh file.
This is useful for large cases where you may want to mesh different parts of the mesh separately
and then merge them together. This enables you to avoid frequent switching between domains for
such cases. You can write out selected boundaries to a mesh file and then create the volume mesh
for the part in a separate session. You can then read the saved mesh into the previous session and
merge the part with the rest of the mesh.
write-case
enables you to write a case file that can be read by Fluent.
Note:
You should delete dead zones in the mesh before writing the mesh or case file for Fluent.
write-domains
enables you to write all the mesh domains (except global) into a file that can be read.
write-mesh
enables you to write a mesh file.
Note:
You should delete dead zones in the mesh before writing the mesh or case file for Fluent.
write-options
enables you to set the enforce mesh topology option for writing mesh/case files.
This option is disabled by default; enabling this option will orient the face zones consistently when
the mesh file is written. If necessary, the zones will be separated, such that each boundary face
zone has at most two cell zones as neighbors, one on either side. Also, internal face zones will be
inserted between neighboring cell zones that are connected by interior faces.
write-size-field
enables you to write a size field file.
Chapter 7: material-point/
create-material-point
enables the definition of a material point. Specify the fluid zone name and the location to define the ma-
terial point.
delete-all-material-points
enables the deletion of all defined material points.
delete-material-point
deletes the specified material point.
list-material-points
lists all the defined material points.
Chapter 8: mesh/
auto-mesh
enables you to generate the volume mesh automatically. Specify a mesh object name for object-based
auto mesh; if no name is given, face zone based auto mesh is performed. Specify the mesh elements to
be used when prompted. Specify whether to merge the cells into a single zone or keep the cell zones
separate. For face zone based meshing, specify whether automatically identify the domain to be meshed
based on the topology information.
Note:
• You can specify the meshing parameters for the mesh elements (prisms, pyramids or non-
conformals, tet, hex or poly) using either the respective dialog boxes or the associated text
commands prior to using the auto-mesh command.
auto-mesh-controls/
enters the auto-mesh-controls submenu
backup-object
enables creation of a backup of the surface mesh before volume meshing starts. This option is enabled
by default.
auto-prefix-cell-zones
enables you to specify a prefix for cell zones created during the auto mesh procedure.
Note:
The auto-prefix-cell-zones command is not relevant for object-based meshing,

where the cell zone names are generated based on the material points and the objects
used to generate the mesh object.
cavity/
enters the cavity menu.
add-zones
enables you to create a cavity for adding new zones to the existing volume mesh.
create-hexcore-cavity-by-region
creates the cavity in the hexcore mesh based on the zones and bounding box extents specified.
create-hexcore-cavity-by-scale
creates the cavity in the hexcore mesh based on the zones and scale specified.
merge-cavity
enables you to merge the specified cavity domain with the parent domain.
mesh/
During the merging operation, the cavity cell zones merges with the zones in the parent domain.
The wall boundaries extracted from the interior zones will be converted to interior type and
merged with the corresponding zones in the parent domain.
region
enables you to create a cavity to modify the existing volume mesh in the specified region.
remove-zones
enables you to create a cavity for removing zones from the existing volume mesh.
replace-zones
enables you to create a cavity for removing a set of zones from an existing volume mesh and replacing
them with new set of zones.
cell-zone-conditions/
contains options for copying or clearing cell zone conditions when a case file is read.
clear
clears the cell zone conditions assigned to the specified zones.
clear-all
clears the cell conditions assigned to all the zones.
copy
enables you to copy the cell zone conditions from the zone selected to the zones specified.
check-mesh
checks the mesh for topological errors.
check-quality
enables you to ensure that the mesh quality is appropriate before transferring the mesh to the solution
mode.
check-quality-level
enables you to report additional quality metrics when set to 1.
In addition to the orthogonal quality and Fluent aspect ratio, additional metrics such as cell squish
and skewness will be reported when the check-quality-level is set to 1.
clear-mesh
enables you to generate a new mesh by deleting the internal mesh and leaving only the boundary faces
and nodes.
create-heat-exchanger
creates the heat exchanger mesh. You need to specify the method for selecting the Location coordinates
(by Position or Nodes), the location coordinates, the parameters for setting up mesh density (by Interval
or Size), and the number of intervals (sizes) between points (nodes) 1–2, 1–3, 1–4. Also specify the ob-
ject/zone name prefix and enable creating the mesh object, if required.
cutcell/
enters the cutcell menu.
Note:
create
creates the CutCell mesh by performing the initialize, refine, snap, and improve operations sequentially.
create-prism
creates the prism layers on the recovered boundary based on the zone-specific prism parameters set.
Specify the cell zones into which the prism layers are to be grown and the gap factor as appropriate.
modify/
enters the cutcell modify menu.
auto-node-move
enables you to use the Auto Node Move utility to improve the CutCell mesh quality.
cavity-remeshing
enables you to use the Cavity Remeshing utility to improve the CutCell mesh quality near the
boundary.
Note:
Face zones of type internal are recovered as type wall in the cutcell mesher.
These should be reset to type internal before using the cavity remesher.
post-morph-improve
improves the quality of the CutCell mesh post-prism generation.
rezone-multi-connected-faces
enables you to resolve multi-connected configurations on the CutCell boundary. Specify an appro-
priate value for the critical count for contiguous manifold faces.
An example is shown in Figure 8.1: Rezoning Multiply Connected Faces (p. 89) where the
multiply connected faces around the surface are removed.
Figure 8.1: Rezoning Multiply Connected Faces
mesh/
split-boundary
creates a copy of the specified CutCell boundary zones and makes the boundary mesh conformal
at the hanging-nodes on the copied zones. The new zones will be named based on the original
zone names and prefixed by split-.
objects/
enters the objects menu.
change-object-type
enables you to change the object type (geom or mesh).
check-mesh
checks the mesh on the specified objects for connectivity and orientation of faces. The domain
extents, volume statistics, and face area statistics will be reported along with the results of other
checks on the mesh.
create
creates the object based on the priority, cell zone type, face zones, edge zones, and object type
specified. You can specify the object name or retain the default blank entry to have the object
name generated automatically.
create-and-activate-domain
creates and activates the domain comprising the face zones from the objects specified.
create-groups
creates a face group and an edge group comprising the face zones and edge zones included in
the specified objects, respectively.
create-intersection-loops
enables you to create intersection loops for objects.
• The collectively option creates an interior edge loop at the intersection between two ad-
jacent face zones included in the same object and between multiple objects.
• The individually option creates an interior edge loop at the intersection between two ad-
jacent face zones included in the same object.
create-multiple
creates multiple objects by creating an object per face zone specified. The objects will be named
automatically based on the prefix and priority specified.
create-new-mesh-object/
contains options for creating a new mesh object by wrapping or remeshing existing objects.
remesh
creates a new mesh object by remeshing geometry objects individually or collectively.
wrap
creates a new mesh object by wrapping the specified objects individually or collectively.
delete
deletes the specified objects.
delete-all
deletes all the defined objects.
delete-all-geom
deletes all the defined geom objects.
delete-unreferenced-faces-and-edges
deletes all the faces and edges that are not included in any defined objects.
extract-edges
extracts the edge zones from the face zones included in the specified objects, based on the edge-
feature-angle value specified (/mesh/cutcell/objects/set/set-edge-feature-angle).
improve-feature-capture
enables you to imprint the edges comprising the object on to the object face zones to improve
feature capture for mesh objects. You can specify the number of imprinting iterations and addi-
tional aggressive imprinting iterations to be performed.
improve-object-quality
This command is not relevant for CutCell meshing.
join-intersect/
The commands in this sub-menu are not relevant for CutCell meshing.
list
lists the defined objects, indicating the respective cell zone type, priority, face zones and edge
zones comprising the object, object type, and object reference point in the console.
merge
merges the specified objects into a single object.
merge-edges
merges all the edge zones in an object into a single edge zone.
Note:
If the object is composed of edge zones of different types (boundary and interior),
the edge zones of the same type (boundary or interior) will be merged into a
single edge zone.
merge-nodes
merges the free nodes at the object level based on the specified tolerance or using a tolerance
that is a specified percentage of shortest connected edge length.
merge-voids
enables you to merge voids in the mesh object after the sewing operation. This command is not
relevant for CutCell meshing.
merge-walls
merges all the face zones of type wall in an object into a single face zone.
remove-gaps/
contains options for removing gaps between mesh objects. The commands in this sub-menu are
not relevant for CutCell meshing.
rotate
rotates the objects based on the angle of rotation, pivot point, and axis of rotation specified.
mesh/
scale
scales the objects based on the scale factors specified.
separate-faces-by-angle
separates the face zones comprising the object based on the angle specified.
separate-faces-by-seed
separates the face zones comprising the object based on the seed face specified.
set/
contains the following options:
set-edge-feature-angle
sets the edge feature angle to be used for extracting edge zones from the face zones included
in the objects.
show-edge-zones?
displays the edge zones comprising the objects drawn in the graphics window.
show-face-zones?
displays the face zones comprising the objects drawn in the graphics window.
sew/
contains options for sewing mesh objects. The commands in this sub-menu are not relevant for
CutCell meshing.
translate
translates the objects based on the translation offsets specified.
update
enables you to update the objects defined when the face and/or edge zones comprising the object
have been deleted.
wrap/
contains options for the object wrapping operation. The commands in this sub-menu are not rel-
evant for CutCell meshing.
set/
enters the CutCell settings menu.
auto-delete-dead-zones?
controls the automatic deleting of the dead zones in the CutCell mesh.
auto-delete-solid-zones?
controls the automatic deleting of the solid zones in the CutCell mesh.
create-material-point
enables you to define a material point.
delete-all-material-points
enables you to delete all defined material points.
delete-material-point
deletes the specified material point.
list-material-points
lists all the defined material points.
max-initial-cells
specifies the maximum number of cells in the initial Cartesian grid.
set-cutcell-quality-method
enables you to set the quality measure for the improve operation. The default measure used is the
orthoskew metric.
set-post-morph-parameters
enables you to set parameters for improving the CutCell mesh post-prism generation using the
command /mesh/cutcell/modify/post-morph-improve.
set-post-snap-parameters
enables you to set parameters for improving the CutCell mesh quality.
set-thin-cut-face-zones
enables you to specify the face zones constituting the thin regions to be recovered during the
CutCell meshing process.
set-thin-cut-edge-zones
enables you to specify the edge zones defining the features in thin regions to be recovered during
the CutCell meshing process.
size-functions/
enters the size functions menu.
compute
computes the size field based on the defined parameters.
contours/
enters the contours sub-menu.
draw
displays contours in the graphics window. Compute the size field using /size-func-
tions/compute or read in a size field file prior to displaying the contours of size.
set/refine-facets?
enables you to specify smaller facets if the original are too large. Default is no.
create
create-defaults
delete
delete-all
list
lists all the defined size functions and the corresponding parameter values defined.
mesh/
list-periodicity-filter
lists the details of the source zone and rotational periodic parameters specified for the size field.
resets the values for the global controls to the defaults.
set-global-controls
sets the values for the global minimum and maximum size, and growth rate.
set-periodicity-filter
enables you to apply periodicity to the size field by selecting one source face zone.
Note:
Ensure that periodicity is previously defined in the Make Periodic Boundaries

dialog box.

currently.
sets the tolerance relative to minimum size to take gaps into account. Gaps whose thickness is less
than the global minimum size multiplied by this factor will not be regarded as a proximity gap.
set-scaling-filter
enables you specify the scale factor, and minimum and maximum size values to filter the size
output from the size field.
identifies the zones comprising non-triangular elements and uses a triangulated copy of these
zones for computing the size functions.
un-set-periodicity-filter
allows you to use curvature data from the nodes of the CAD facets.
domains/
enters the domain menu.
activate
activates the specified domain for meshing or reporting operations.
create
creates a new domain based on the specified boundary face zones. Ensure valid boundary zones
are specified; specifying invalid zones will generate an error.
create-by-cell-zone
creates a new domain based on the specified cell zone.
create-by-point
creates a new domain based on the specified
Note:
The create-by-point option works only for cases with no overlapping face zones.
delete
deletes the specified domain.
draw
displays the boundary face zones of the specified domain.
print
prints the information for the specified domain.
hexcore/
enters the hexcore menu.
controls/
enters the hexcore controls menu.
buffer-layers
sets the number of addition cells to mark for subdivision.
compute-max-cell-length
computes the maximum cell length for the hexcore mesh.
define-hexcore-extents?
enables you to extend the hexcore mesh to specified domain extents and/or selected planar
boundaries. When enabled, the outer-domain-params sub-menu will be available.
delete-dead-zones?
toggles the automatic deleting of the dead zones.
island-thresholds
opens a dialog to set absolute-island-count (default is 50) and island-volume-frac-
tion (relative to total volume of hex cells, default is 1e-06). For a cell region to be interpreted as
an island, both cell count and relative volume thresholds may not be exceeded.
keep-hex-tet-separate?
toggles the merging of Cartesian cells with the tet (and wedge) cells at the end of the hexcore
meshing process.
maximum-cell-length
sets the maximum cell length for the hex cells in the domain.
maximum-initial-cells
specifies the maximum number of cells in the initial Cartesian mesh.
maximum-subdivisions
number of changes in size (hanging node subdivisions) allowed in the hex mesh region. The default
is 50.
mesh/
non-fluid-type
selects the default non-fluid cell zone type. After the mesh is initialized, any non-fluid zones will
be set to this type. If the mesh includes multiple regions (for example, the problem for which you
are creating the mesh includes a fluid zone and one or more solid zones), and you plan to refine
all of them using the same refinement parameters, modify the Non-Fluid Type before generating
the hexcore mesh.
Note:
For zone-based meshing, if any cell zone has at least one boundary zone type as
inlet, it will automatically be set to fluid type. For object based meshing, volume
region type is used to determine the cell zone type.
octree-hexcore?
speeds up hexahedral core generation by enabling the octree technique for hexcore mesh gener-
ation. This option is disabled by default.
Body-of-influence sizing may be used for refinement.
This option does not support hexcore generation up to boundaries.
only-hexcore?
enables you to create only the hexcore mesh and activates the tetrahedral mesh domain (without
tetrahedral mesh generation). It enables you to prevent the automatic creation of the mesh after
hexcore generation. This option is disabled by default. This option is not available for object-based
meshing.
outer-domain-params/
contains options for defining the outer domain parameters. This sub-menu is available only when
define-hexcore-extents? is enabled.
specify-coordinates?
enables you to specify the extents of the hexcore outer box using the coordinates command.
coordinates
specifies the extents (min and max coordinates) of the hexcore outer box. This command is
available when the specify-coordinates? option is enabled.
specify-boundaries?
enables you to specify selected boundaries to which the hexcore mesh is to be generated using
the boundaries command.
boundaries
specifies the boundaries to which the hexcore mesh is to be generated when the specify-
boundaries? option is enabled. After specifying the boundaries, the auto-align?, de-
lete-old-face-zones?, and list options will also be available.
auto-align?
enables you to axis-align non-aligned planar boundaries to which hexcore mesh is to be gen-
erated. This option is available only when the specify-boundaries? option is enabled
and the boundaries are specified.
auto-align-tolerance
specifies the tolerance for aligning boundary zones when auto-align? is enabled.
auto-align-boundaries
aligns the boundary zones specified (using the boundaries command) with the tolerance
specified \ (using the auto-align-tolerance command) when auto-align? is enabled.
delete-old-face-zones?
enables you to delete the original tri face zones that have been replaced during the hexcore
meshing process. This option is available only when the specify-boundaries? option is
enabled and the boundaries are specified.
list
lists the boundaries to which the hexcore mesh is to be generated. This option is available only
when the specify-boundaries? option is enabled and the boundaries are specified.
peel-layers
specifies the distance for the hexcore interface to peel-back from the boundary. The default value
is 0. The higher the value of peel layer, the bigger the distance between the hexcore interface and
the boundary.
skip-tet-refinement?
enables you to omit the tetrahedral refinement phase for reducing total cell count (default is no).
Hex cell count is unaffected.
Tip:
It is recommended to use peel-layers equal 0 when this option is enabled.
Warning:
This option may leave narrow regions without hexcore mesh. Tetrahedral cells
with lower quality may be created in such regions, reducing the overall mesh
quality.
smooth-interface?
enables smoothing of the hexcore interface.
smooth-iterations
specifies the number of smoothing iterations.
smooth-relaxation
specifies the surface smoothing relaxation factor.
create
enables you to create the hexcore mesh according to the specified parameters.
local-regions
enters the hexcore local refinement region sub-menu.
activate
enables you to activate the specified local regions for refinement.
mesh/
deactivate
enables you to deactivate the specified local regions for refinement.
define
defines the local region according to the specified parameters.
delete
ideal-hex-vol
reports the ideal hex volume for the given edge length.
init
creates a default region encompassing the entire geometry.
list-all-regions
lists the defined and active regions in the console.
laplace-smooth-nodes
applies a Laplacian smoothing operator to the mesh nodes. This command can be used for smoothing of
all cell types, including prismatic cells.
list-mesh-parameter
shows all mesh parameters.
manage/
enters the manage cell zones menu.
active-list
lists all active zones.
adjacent-face-zones
lists all face zones that refer to the specified cell zone.
auto-set-active
sets the active zones based on points that are defined in an external file. For each zone you want to
activate, you need to specify the coordinates of a point in the zone, the zone type (for example, fluid),
and (optionally) a new name. A sample file is shown below:
((1550.50 -466.58 896.41) fluid heater-#)
((1535.83 -643.14 874.71) fluid below-heater-#)
((1538.73 -444.28 952.69) fluid above-heater-#)
((1389.18 -775.51 825.97) fluid plenum-#)
Here, four fluid zones are identified, renamed, and activated. Any zone that you identify in the
file will automatically be activated. The # indicates that the mesher should append the appro-
priate ID number for the zone.
Warning:
This command is valid only for tet meshes.
change-prefix
enables you to change the prefix for the cell zone.
copy
copies all nodes and faces of specified cell zones.
delete
deletes a cell zone, along with its associated nodes and faces.
get-material-point
prints the coordinates of the material point for the specified cell zone.
Note:
If the cell zone is non-contiguous, the get-material-point command will print

a list of material points, one for each contiguous region.
id
specifies a new cell zone ID. If a conflict is detected, the change will be ignored.
list
prints information on all cell zones.
merge
merges two or more cell zones.
Note:
For object-based merge, the selected zones must be in the same volumetric region.
If not, you will have to merge the volumetric regions first using /objects/volu-
metric-regions/merge. If the volumetric regions cannot be merged because
they are not contiguous, you will have to delete the object(s) only before merging
the cell zones.
merge-dead-zones
enables you to merge dead zones having a cell count lower than the specified threshold value, with
the adjacent cell zone. The result of the merge operation is determined by the type of the adjacent
cell zone and the shared face area. The priority for merging with the adjacent cell zone based on type
is fluid > solid > dead (that is, merging with an adjacent fluid zone takes priority over merging with
an adjacent solid zone, which in turn takes priority over merging with a dead zone). Also, if the adjacent
zones are of the same type (for example, fluid), the zone will be merged with the zone having the
largest shared face area.
name
enables you to rename a cell zone.
origin
specifies a new origin for the mesh, to be used for cell zone rotation. The default origin is (0,0,0).
revolve-face-zone
generates cells by revolving a face thread.
rotate
rotates all nodes of specified cell zones by a specified angle.
mesh/
rotate-model
rotates all nodes of the model by a specified angle.
scale
scales all nodes of specified cell zones by a specified factor.
scale-model
scales all nodes of the model by a specified factor.
set-active
sets the specified cell zones to be active.
translate
translates all nodes of specified cell zones by a specified vector.
translate-model
translates all nodes of the model by a specified vector.
type
changes the type and name of a cell zone.
modify/
enters the mesh modify menu.
auto-improve-warp
enables you to improve face warp by node movement. Specify the appropriate cell zones and
boundary zones, the maximum warp, the number of iterations per face to be improved, and the
number of iterations of the automatic node movement procedure (default, 4).
auto-node-move
enables you to improve the mesh quality by node movement. Specify the appropriate cell zones and
boundary zones, the quality limit based on the quality measure selected, dihedral angle, the number
of iterations per node to be moved and the number of iterations of the automatic node movement
procedure (default, 1). You can also choose to restrict the movement of boundary nodes along the
surface.
clear-selections
clears all items from the selection list.
deselect-last
deselects the last item you selected using the select-entity command.
extract-unused-nodes
places all unused nodes in a separate interior node zone.
list-selections
lists all items in the selection list.
list-skewed-cells
lists cells with skewness in a specified range.
mesh-node
attempts to introduce a new node into the existing mesh.
mesh-nodes-on-zone
inserts nodes associated with node or face zone into the volume mesh.
Important:
If a face zone is specified, the faces are deleted before the nodes are introduced into
the mesh.
neighborhood-skew
reports the maximum skewness of cells using the specified node.
refine-cell
attempts to refine the cells in the probe list by introducing a node nears its centroid. This technique
is useful for removing very flat cells near the boundary when boundary sliver removal is not possible.
After refining the cell, you should smooth the mesh.
repair-negative-volume-cells
repairs negative volume cells by moving nodes. Specify the appropriate boundary zones, the number
of iterations per node to be moved, dihedral angle, whether to restrict the movement of boundary
nodes along the surface, and the number of iterations of the automatic node movement procedure
(default, 1).
select-entity
adds an entity (face, node, cell, etc.) to the selection list.
smooth-node
applies Laplace smoothing to the nodes in the selection list.
non-conformals/
enters the non-conformals menu.
controls/
enters the non-conformals controls menu.
enable?
toggles the creation of a non-conformal interface.
retri-method
specifies the method to be used for retriangulating the quad faces on the non-conformal zones.
prism
remeshes the prism-side quad zones named prism-side* or *-quad*.
quad-split
splits the quad faces diagonally into tri faces.
remesh
remeshes all the quad faces based on the edge and surface feature angle specified.
create
creates the non-conformal interface on the specified face zones using the specified retriangulation
method.
mesh/
separate
enables you to separate the face zones comprising the non-conformal interface between the cell zones
specified. Specify the cell zones where the interface is non-conformal, an appropriate gap distance,
and the critical angle to be used for separating the face zones. You can also choose to orient the
boundary face zones after separation and additionally write a journal file for the separation operation.
Note:
If you choose to write a journal file when using the /mesh/non-conformals/sep-

arate command to separate the mesh interface zones, you can read the journal file
to create the mesh interface automatically in solution mode.
poly/
enters the polyhedral mesh generation menu.
collapse
merge nodes to remove short edges and small faces. The decision threshold uses edge size ratio, face
size ratio, and (face) area fraction.
controls/
enters the controls menu for setting poly parameters.
cell-sizing
sets cell volume distribution function as geometric, linear, or size-field.
edge-size-ratio
sets the threshold for the size ratio of two connected edges. Recommended range is 20 to 200.
face-size-ratio
sets the threshold for the size ratio of two faces on one cell. Recommended range is 100 to 300.
feature-angle
sets the minimum threshold that should be preserved as a feature.
improve?
enables poly mesh improvement by smoothing based on the smooth-controls.
merge-skew
sets the minimum skewness threshold for cell merge.
non-fluid-type
selects the default type for non-fluid zones.
remesh-skew
sets the target skewness when remeshing.
sliver-cell-area-fraction
sets the threshold for the area of a single face to the cell surface area. Recommended range is
0.00001 to 0.001.
smooth-controls/
enters the menu for setting smoothing parameters for poly mesh.
centroid-smooth-iterations
sets the number of passes for tet-cell centroid smoothing during the poly mesh generation
phase.
edge-smooth-iterations
sets the number of passes for tet-cell edge smoothing during the poly mesh generation phase.
laplace-smooth-iterations
sets the number of passes for tet-cell Laplace smoothing during the poly mesh generation
phase.
smooth-attempts
sets the maximum number of movements for a single node during poly mesh smoothing.
smooth-boundary
enables boundary smoothing as part of poly cell smoothing. Default is no.
smooth-iterations
sets the number of improvement passes over the full poly mesh.
smooth-on-layer
constrains movement of nodes to maintain layering during poly mesh smoothing.
smooth-skew
sets the minimum skewness threshold for poly mesh smoothing.
improve
allows you to improve the polyhedral mesh quality based on the quality-method.
local-regions/
Note:
Poly meshing follows tet meshing. These commands behave like the equivalent
commands under /mesh/tet/local-regions/.
activate
activates the specified regions for refinement.
deactivate
deactivates the specified regions for refinement.
define
delete
ideal-vol
reports the volume of an ideal tetrahedron for the edge length specified.
init
defines the default refinement region encompassing the entire geometry.
mesh/
list-all-regions
lists all refinement region parameters and the activated regions in the console.
refine
refines the active cells inside the selected region based on the specified refinement parameters.
quality-method
asks you to choose from internal-default, orthoskew or squish quality measure for mesh
improvement.
remesh
improves the quality in a local region based on the minimum skewness threshold.
poly-hexcore,
enters the menu for poly-hexcore mesh.
controls
enters the menu for setting parameters for poly-hexcore mesh.
avoid-1:8-cell-jump-in-hexcore
determines the types of cells (large cells, small cells, or both) that are going to be replaced with
polyhedra cells in order to avoid any 1:8 cell jumps in the hexcore region.
mark-core-region-cell-type-as-hex?
determines whether or not to apply hexahedra cells in the core region of the mesh. The default
value is yes.
only-polyhedra-for-selected-regions
determines if polyhedra cells are to be applied to the selected regions.
prepare-for-solve
prepares the mesh for solving in solution mode by performing a cleanup operation after the volume mesh
has been generated. Operations such as deleting dead zones, deleting geometry objects, deleting edge
zones, removing face/cell zone name prefixes and/or suffixes, deleting unused faces and nodes are per-
formed during this operation.
prism/
enters the prism menu.
controls/
enters the prism controls menu.
adjacent-zone/
enters the prism adjacent zone controls menu.
project-adjacent-angle
determines whether or not to project to an adjacent zone. If a zone shares outer nodes with
any of the zones from which the layers are being grown (the “base zones”), its angle with respect
to the growth direction is compared with this value. If the angle is less than or equal to this
value, then the zone will be projected to. The default value is 75 degrees. See Using Adjacent
Zones as the Sides of Prisms for details.
project-converged
sets the convergence criterion for iterative projection. This is non-dimensionalized by the offset
height at each local node.
project-iter
sets the maximum number of iterations to perform when projecting to multiple zones. Most
projections converge in only a few iterations. There is normally no need to change this value.
project?
enables/disables projection of outer nodes to adjacent zones.
retri-feature-angle
enables you to specify the feature angle that should be prevented while generating prisms.
retriangulate-adjacent?
specifies whether or not triangular face zones adjacent to which outer nodes have been pro-
jected, will be automatically retriangulated.
side-feature-align-angle
specifies the angle used for aligning projected normals along a feature edge.
side-feature-angle
specifies the angle used for computing the feature normals.
side-topology-align-angle
specifies the angle used for aligning projected normals along a particular feature edge based
on the topology. This is particularly useful when the side-feature-angle specified is not
sufficient to decide the feature edge to align the projected normals.
auto-separate-cells?
enables/disables automatic separation of the cells extruded from different face zones to different
cell zones.
Note:
This option is not considered when the auto-mesh option is used to generate
the mesh.
check-quality?
enables/disables the checking of volume, skewness, and handedness of each new cell and face.
grow-individually?
specifies whether prisms should be grown from multiple zones individually so that the individual
prism cell zones and the individual cap face zones are retained.
improve/
enters the prism smoothing controls menu.
check-allowable-skew?
enables you to check the skewness of the prism cap for every layer.
check-size?
enables the checking of cell size during the generation of each prism layer. An error will be
reported if zero-area prism cells are generated and prism layer growth will be stopped.
mesh/
When the check-size? option is disabled, the zero-area prism cells generated can be
removed during the improvement smoothing operations performed at the end of the prism
generation procedure.
corner-height-weight?
when enabled, the offset height at corners with large angles (for example, 270º) is reduced to
give a smoother prism cap.
edge-smooth-angle
specifies the maximum allowable angle between the normals of adjacent cap faces for skewness-
driven edge smoothing.
edge-smooth?
enables/disables local smoothing of nodes of the longest edges of skewed faces. This option
is switched off by default.
edge-swap-base-angle
specifies the maximum allowable angle between the normals of the base faces for skewness-
driven edge swapping.
edge-swap-cap-angle
specifies the maximum allowable angle between the normals of the cap faces for skewness-
driven edge swapping.
edge-swap?
enables/disables edge swapping to decrease the skewness of highly skewed faces. This option
is switched off by default.
face-smooth-converged
specifies the convergence criteria for cap face smoothing.
face-smooth-rings
sets the number of rings around each node to be smoothed. If zero, only a node itself is
smoothed. If one, the node and all of its neighbors are smoothed. If two, the neighbors of the
neighbors are also smoothed, and so on.
face-smooth-skew
specifies the minimum skewness to smooth cap faces.
face-smooth?
enables face-driven smoothing to improve skewness.
identify-feature-line?
enables you to smooth the normal along the feature lines of the base face zones, during normal
smoothing. This option is disabled by default.
improve-warp?
enables or disables improving of face warp during prism generation. This option is disabled
by default.
layer-by-layer-smoothing?
enables you to improve cell quality for every layer by smoothing normals in the current layer.
In addition, perturbation smoothing will be performed to improve cell quality in the lower
layer, when the quality measure is set to either skewness, squish, ICEM CFD quality, or orthoskew.
The poor quality elements are identified based on the value set for max-allowable-cell-
skew. The cell aspect ratio will also be maintained during the cell quality improvement. This
option is switched off by default.
left-hand-check
controls checking for left-handedness of faces. The default setting of 0 implies face handedness
will not be checked. A value of 1 implies only cap faces will be checked, while 2 implies faces
of all cells in current layer will be checked.
max-allowable-cap-skew
specifies the maximum skewness allowed for a prism cap face. If the skewness of a cap face
exceeds this value, the meshing process will stop and a warning indicates that the skewness
for that layer is too high.
max-allowable-cell-skew
specifies the cell quality criteria for smoothing and quality checking.
node-smooth-angle
refers to the maximum deviation of a node’s sharpest angle (that is, the most acute angle
between adjacent faces that use the node) from 180 degrees. The node will be smoothed only
if its sharpest angle falls within this range.
node-smooth-converged
sets the convergence criterion for node smoothing. If the node positions are changing by less
than this value, smoothing iterations will stop.
node-smooth-iter
specifies the maximum number of node smoothing iterations to be performed for the nodes
on each layer. These iterations will be performed until the convergence criterion is reached.
node-smooth-local?
enables node smoothing to converge locally. This is useful for large geometries.
node-smooth-rings
controls the locality of node smoothing by setting the number of rings around each node to
be smoothed. If zero, only the node itself is smoothed. If one, the node and all of its neighbors
are smoothed. If two, the neighbors of the neighbors are also smoothed, and so on.
node-smooth?
enables/disables node smoothing to decrease skewness. This option is switched off by default.
post-adjust-height?
enables you to perform prism height adjustment based on growth rate.
shrink-left-handed-cap?
enables shrinking of prism layers to remove left handed faces.
smooth-improve-prism-cells?
enables you to set the parameters for improving the prism cells after the required prism layers
are created. You can select optimized smoothing (smooth), node movement (improve), or
a combination of both to improve the quality. Specify the quality measure to be used, the cell
quality threshold, the number of improvement iterations, and the minimum improvement re-
quired.
mesh/
swap-smooth-skew
specifies the skewness threshold for edge swapping and edge and node smoothing. The faces
with skewness greater than or equal to the specified value will be swapped and/or smoothed.
merge-ignored-threads?
enables you to automatically merge all ignored zones related to a base thread into a single thread.
This option is enabled by default. When this option is disabled, more than one ignored thread will
be generated per base thread. However, various zones can be created by ignoring this option.
They are:
*:dwall
is formed due to dangling wall.
*:prox
is formed due to proximity.
*:ud_normal
is formed due to invalid normal.
*:smooth
is formed due to smoothing of ignored regions.
The default value of the tgvar prism/ignore-extension (for which there is no TUI
command) is 1. It means that after the prism generation is over, all the ignored regions are
expanded by this number. If we expand say by n times, that is if prism/ignore-exten-
sion is set to n using tgsetvar! (with the exclamation mark), more ignored threads will
be created because of expanding ignored regions. These regions will be named as follows:
*:cell_delete_1, *:cell_delete_2, *:cell_delete_3,.... up to \

*:cell_delete_n
If merge-ignored-threads? is enabled, then all these are merged and you finally get
only one zone per base thread, named as *:ignore.
morph/
enters the prism morphing controls menu.
improve-threshold
specifies the quality threshold used for improving the quality during the morphing operation.
morphing-convergence-limit
specifies the convergence limit for the morphing operation. The morpher uses an iterative
solver. It is assumed to have converged when the relative residual is less than this number.
morphing-frequency
specifies the frequency of the morphing operation. The number specified denotes the number
of prism layers after which the morpher is applied to the remainder of the mesh (for example,
a value of 5 indicates that the morpher is applied to the mesh after every 5 prism layers grown).
normal/
enters the prism normal controls menu.
bisect-angle
is required for growing prisms out of sharp interior corners. When the value of this angle is set,
the normals are automatically projected onto the plane bisecting the angle between faces
having an interior angle less than this angle.
compute-normal
computes the normal for the specified face zone.
converge-locally?
specifies whether or not the normal smoothing at each node is frozen once convergence is
satisfied at that node. If not, all normals are continuously smoothed until all of them have
converged.
direction-method
specifies whether the prism layers should be grown normal to surfaces or along a specified
direction vector.
direction-vector
specifies the direction vector for prism extrusion when the uniform method is selected for
direction-method.
ignore-invalid-normals?
enables you to ignore nodes that have poor normals.
max-angle-change
specifies the maximum angle by which the normal direction at a node can change during
smoothing.
normal-method
gives options for the method to use for computing the normal direction.
acute-bisection
is a variation of that proposed by Kallinderis et al. [7], [8]. The faces surrounding a node are
analyzed to find those whose planes form the most acute angle. The resulting normal lies
on the plane bisecting those two planes.
This method is computationally more expensive than surface averaging, but is less
robust at singular points where convex edges meet smooth surfaces. For example,
if a box is sitting on the table, such a point would be where one of the box’s corners
meets the table top.
face-average
computes the normal at a node by averaging the normals of the surrounding faces.
hybrid-normal
computes the normal by all the methods available and uses the best quality normal ob-
tained. This is the default method.
minimized-angle
is a variation of that proposed by Pirzadeh [14], [15]. An ial normal at a node is determined
by averaging the normals of the surrounding faces (the face-average method). Iterations
are then performed to minimize the largest angle between the node normal and the normals
of the surrounding faces.
mesh/
This method is a computationally more expensive than surface averaging, and can
produce slightly better normals when the uniform offset method is used and the
surface mesh does not contain sharp edges. When the minimum-height offset
method is used, this direction method may introduce spikes and pits in the advancing
layer surfaces.
surface-average
is similar to face-average, but handles sharp edges better.
orient-mesh-object-face-normals
enables you to orient the face normals for mesh object boundary zones. Specify the mesh object,
region or material point as appropriate, and specify whether walls, baffles or both comprising
the prism base zones are to be separated and oriented.
orthogonal-layers
specifies the number of layers to preserve orthogonality. All smoothing is deferred until after
these layers.
smooth-converged
sets the convergence criterion (in degrees) for normal smoothing. If the normal directions are
changing by less than this value, smoothing iterations will stop.
smooth-iter
specifies the maximum number of normal smoothing iterations to be performed for the normal
vectors on each layer. These iterations will be performed until the convergence criterion
(normal/smooth-converged) is reached.
smooth?
enables or disables smoothing of normal direction vectors.
offset/
enters the prism offset controls menu.
first-aspect-ratio-min
specifies the minimum first aspect ratio (ratio of prism base length to prism layer height) for
the prism cells.
min-aspect-ratio
specifies the minimum aspect ratio (ratio of prism base length to prism layer height) for the
prism cells.
smooth-converged
sets the convergence criterion for offset smoothing. If the offset heights are changing by less
than this value, smoothing iterations will stop.
smooth-iter
sets the maximum number of offset smoothing iterations to be performed. These iterations
will be performed until the convergence criterion offset/smooth-converged is reached.
smooth?
enables/disables offset distance smoothing.
post-ignore/
contains options for setting the parameters for removing poor quality prism cells after the required
prism layers are created.
post-remove-cells?
enables you to set the parameters for removing poor quality prism cells after the required
prism layers are created. You can remove cells based on quality, intersection, interior warp,
and feature edges. Specify options for removing additional cells in regions of high aspect ratio
and feature angle, the number of cell rings to be removed around the marked cells, and options
for smoothing the prism boundary and prism side height.
proximity
enters the prism proximity controls menu.
allow-ignore?
enables you to ignore nodes where the specified maximum shrink factor cannot be maintained.
allow-shrinkage?
enables shrinkage while growing prism layers.
gap-factor
controls the gap between the intersecting prisms layers in the proximity region with respect
to the cell size of the prisms.
keep-first-layer-offsets?
enables you to retain first layer offsets while performing proximity detection.
max-aspect-ratio
specifies the maximum allowable cell aspect ratio to determine the limit for the shrinkage of
prism layers. This option is available only when the allow-ignore? option is disabled.
max-shrink-factor
specifies the shrink factor determining the maximum shrinkage of the prism layers. This option
is available only when the allow-ignore? option is enabled.
smoothing-rate
specifies the rate at which shrinkage is propagated in lateral direction.
remove-invalid-layer?
removes the last prism layer if it fails in the quality check.
set-post-mesh-controls
sets controls specific to growing prisms post volume mesh generation.
split?
enables you to set parameters for splitting the prism layers after the initial prism layers are gener-
ated, to generate the total number of layers required. Specify the number of divisions per layer.
zone-specific-growth
enters the prism growth controls menu.
apply-growth
applies the zone-specific growth parameters specified.
mesh/
clear-growth
clears the zone-specific growth specified.
list-growth
lists the zone-specific growth parameters specified for individual zones in the console.
create
creates prism layers on one or more boundary face zones based on the offset method, growth method,
number of layers, and rate specified.
improve/
enters the prism improve menu.
improve-prism-cells
collects and smooths cells in layers around poor quality cells. Cells with quality worse than the
specified threshold value will be identified, and the nodes of the cells surrounding the poor quality
cells will be moved to improve quality.
smooth-brute-force?
forcibly smooths cells if cell skewness is still high after regular smoothing.
smooth-cell-rings
specifies the number of cell rings around the skewed cell used by improve-prism-cells.
smooth-improve-prism-cells
uses a combination of node movement and optimized smoothing to improve the quality. This
command is a combination of the smooth-prism-cells and improve-prism-cells
commands. The cell aspect ratio will also be maintained based on the value specified for max-
aspect-ratio.
smooth-prism-cells
enables optimization based smoothing of prism cells. The nodes of cells with quality worse than
the specified threshold value will be moved to improve quality. The cell aspect ratio will also be
maintained based on the value specified for max-aspect-ratio.
smooth-sliver-skew
specifies the skewness above which prism cells will be smoothed.
list-parameters
shows all prism mesh parameters.
mark-ignore-faces
enables you to mark the faces to be ignored during prism meshing.
mark-nonmanifold-nodes
enables you to mark the non-manifold prism base nodes. A list of the non-manifold nodes will be
printed in the console. The faces connected to the non-manifold nodes will also be marked. You can
use this command after specifying zone-specific prism settings, prior to generating the prisms to
verify that non-manifold configurations do not exist.
post-ignore/
contains the following options for ignoring prism cells:
create-cavity
creates a cavity in regions where prism quality is adequate, but the quality of adjacent tetrahedra
is poor. The cavity is created based on the tetrahedral cell zone, the quality measure and the cor-
responding threshold value, and the additional number of cell rings specified. You can create a
cavity comprising only tetrahedral cells or optionally include prism cells in the cavity created. When
prism cells are also included in the cavity, you can specify whether the non-conformal interface is
to be created.
mark-cavity-prism-cap
marks the prism cap faces and tetrahedral cell faces bounding the cavity to be created in regions
where prism quality is adequate, but the quality of adjacent tetrahedra is poor. Specify the tetra-
hedral cell zone, the quality measure and the corresponding threshold value to be used, and the
additional number of cell rings based on which the cavity will be created.
mark-prism-cap
marks the prism cap faces for ignoring prism cells in regions of poor quality cells and sharp corners.
Specify the prism cell zone and the basis for ignoring prism cells and the relevant parameters. The
prism cells can be ignored based on quality, intersection, (both enabled by default), warp, and
features (both disabled by default). Specify the quality measure and threshold value to be used
for ignoring cells based on quality and (if applicable) the feature edges for ignoring cells based on
features. Additionally, specify whether cells are to be marked in regions of high aspect ratio and
based on feature angle, and the additional number of cell rings based on which prism cells will be
removed.
post-remove-cells
enables you to remove prism cells in layers around poor quality cells and sharp corners. Specify
the prism cell zone, the basis for ignoring prism cells (quality, intersection, warp, features) and the
relevant parameters. Specify the number of cell rings to be removed around the marked cells. Cells
will be marked for removal in regions of sharp corners based on quality, intersection, warp, and
features (as applicable) and then extended based on the number of cell rings specified. Additional
cells will be marked for removal in regions of high aspect ratio and based on feature angle (if ap-
plicable) around the exposed prism side. The boundary will be smoothed at feature corners after
the prism cells have been removed. The prism-side faces exposed by the removal of the prism cells
will be collected in a zone named prism-side-#, while for a zone wall-n, the faces correspond-
ing to the ignored prism cells will be collected in a zone named wall-n:ignore. You can also
optionally smooth the prism side nodes from the base node to the cap node to create better tri-
angles for the non-conformal interface.
quality-method
specifies the quality method used during prism generation.
reset-parameters
resets all prism parameters.
split/
contains options for splitting the prism layers after the initial prism layers are generated, to generate
the total number of layers required.
split
enables you to split the prism layers after the initial prism layers are generated, to generate the
total number of layers required. Specify the prism cell zones to be split and the number of divisions
per layer. You can also choose to use the existing growth rate (default) or specify the growth rate
to be used while splitting the prism layers.
mesh/
pyramid/
enters the pyramid menu.
controls/
enters the pyramid controls menu.
neighbor-angle
sets the threshold dihedral angle used to limit the neighboring faces considered for pyramid cre-
ation. For example, if the value is set to 110° and the angle between a given quadrilateral face and
a neighboring triangular face is greater than 110°, the resulting pyramid will not include the trian-
gular face.
offset-factor
specifies the fraction of the computed pyramid height (offset) by which the pyramid heights will
be randomly adjusted. The default value is 0, indicating that all pyramids will have the exact height
computed. A value of 0.1, for example, will limit each adjustment to ±10% of the computed height.
offset-scaling
specifies the scaling, to be used to determine the height of the pyramid.
vertex-method
specifies the method by which the location of the new vertex of the pyramid will be determined.
The skewness method is used by default.
create
creates a layer of pyramids on the quad face zone.
repair-face-handedness
reverses face node orientation.
reset-mesh
clears the entire mesh.
reset-mesh-parameter
resets all parameters to their default value.
scoped-prisms/
contains options for creating scoped prism controls for mesh objects.
create
creates a new scoped prism control based on the parameters and scope specified. Specify the name,
offset method, first height or aspect ratio, number of layers, and rate or last percent. Select the mesh
object and set the scope (fluid-regions, named-regions, or solid-regions). Specify the
zones to grow prisms (all-zones, only-walls, selected-face-zones, or selected-labels,
or solid-fluid-interface). When named-regions and/or selected-face-zones or
selected-labels are selected, specify the volume and/or boundary scope. If interior baffle zones
are selected, retain the option to grow prisms on both sides of the baffles or disable it to grow prisms
on one side.
delete
deletes the specified scoped prism control.
growth-options
enables you to specify scoped prism growth options. Select Fix First Height if required, and
specify the gap factor, maximum aspect ratio, prism quality method, and the threshold quality value
for stair stepping.
list
lists all the defined scoped prism controls.
modify
modifies the specified control based on the parameters specified.
read
reads in the specified scoped prism control file (*.pzmcontrol).
set-no-imprint-zones
used to specify face zones that should not be imprinted during prism generation.
write
writes the scoped prism controls to a prism control file (*.pzmcontrol). Specify the scoped prism file
name.
selective-mesh-check
performs a customized mesh check on specific zones rather than all zones.
separate
separates cells by various user-defined methods.
local-regions/
define
enables you to define the parameters for the refinement region.
delete
enables you to delete a refinement region.
init
deletes all current regions and adds the default refinement region.
list-all-regions
lists all the refinement regions.
separate-cell-by-face
separates cells that are connected to a specified face zone into another cell zone. This separation
method applies only to prism cells.
separate-cell-by-mark
separates cells within a specified local region into another cell zone.
separate-cell-by-region
separates contiguous regions within a cell zone into separate cell zones.
separate-cell-by-shape
separates cells with different shapes (pyramids, tetrahedra, etc.) into separate cell zones.
mesh/
separate-cell-by-size
separates cells based on the specified minimum and maximum cell sizes.
separate-cell-by-skew
separates cells based on the specified cell skewness.
tet/
enters the tetrahedral mesh menu.
controls/
enters the tet controls menu.
adv-front-method
enters the advancing front refinement controls menu.
first-improve-params
defines the refining front improvement parameters for the advancing front method.
refine-parameters
defines the cell zone improvement parameters for the advancing front method.
second-improve-params
defines the cell zone improvement parameters for the advancing front method.
skew-improve/
enters the refine improve controls menu.
attempts
specifies the number of overall improvement attempts for the advancing front method.
boundary-sliver-skew
specifies the boundary sliver skewness for the advancing front method. This parameter is
used for removing sliver cells along the boundary.
iterations
specifies the number of improvement iterations in each attempt for the advancing front
method.
sliver-skew
specifies the sliver skewness for the advancing front method. This parameter is used for
removing sliver cells in the interior.
target-low-skew
specifies the targeted skewness threshold above which cells will be improved. The improve
operation will attempt to improve cells with skewness above the target-low-skew
value specified, but there will be no attempt to reduce the skewness below the specified
value. A limited set of improve operations will be used as compared to the operations re-
quired for the target-skew value-based improvement. The value specified could be
approximately 0.1 lower than the target-skew value.
target-skew
specifies the targeted skewness during improvement for the advancing front method.
target?
enables you to enable targeted skewness-based refinement for the advancing front
method. This option enables you to improve the mesh until the targeted skewness value
is achieved.
advanced/
enters the advanced tet controls menu.
defaults?
enables/disables the use of the default values for the initialization parameters.
freeze-boundary-cells
freezes the boundary cells during mesh improvement and sliver removal operations.
keep-virtual-entities?
enables/disables the automatic deleting of virtual entities after mesh initialization.
max-cells
sets the maximum number of cells in the mesh.
max-nodes
sets the maximum number of nodes in the mesh.
Warning:
Be careful when you set upper limits on the number of cells or nodes. Nodes
or cells will not be added when the prescribed limit is reached, and this may
leave the mesh unevenly refined and less than adequate.
node-tolerance
defines the smallest distance between two distinct nodes. This command is available only
when you disable the use of default values for the initialization parameters.
progress-reports
enables you to set the time between progress reports in seconds.
report-max-unmeshed
reports the maximum number of unmeshed entities.
report-unmeshed-faces?
reports the unmeshed faces.
report-unmeshed-nodes?
reports the unmeshed nodes.
sliver-size
is the smallest cell whose size can be determined accurately. This command is available only
when you disable the use of default values for the initialization parameters.
cell-sizing
specifies the cell sizing function for refinement. You can select geometric, linear, none, or
size-field as appropriate.
mesh/
compute-max-cell-volume
computes the maximum cell volume for the current mesh.
delete-dead-zones?
specifies the maximum allowable cell volume.
delete-unused-nodes?
toggles the deleting of unused nodes during mesh initialization.
improve-mesh/
enters the improve mesh controls menu.
improve?
automatically improves the mesh.
laplace-smooth
enables you to specify the Laplace smoothing parameters.
skewness-smooth
enables you to specify the skewness smooth parameters.
swap
enables you to specify the face swap parameters.
improve-surface-mesh?
enables you to improve the surface mesh by swapping face edges where Delaunay violations occur.
max-cell-length
specifies the maximum allowable cell length.
max-cell-volume
specifies the maximum allowable cell volume.
merge-free-nodes?
enables/disables the merging of free nodes during mesh initialization.
non-fluid-type
selects the non-fluid cell zone type. After the mesh is initialized, any non-fluid zones will be set to
this type. If the mesh includes multiple regions (for example, the problem for which you are creating
the mesh includes a fluid zone and one or more solid zones), and you plan to refine all of them
using the same refinement parameters, modify the non-fluid type before generating the mesh.
Note:
For zone-based meshing, if any cell zone has at least one boundary zone type as
inlet, it will automatically be set to fluid type. For object based meshing, volume
region type is used to determine the cell zone type.
refine-levels
sets the number of refinement levels.
refine-method
enables you to select the refinement method. You can select either skewness-based refinement
or the advancing front method.
remove-slivers/
enters the sliver remove controls menu.
angle
specifies the maximum dihedral angle for considering the cell to be a sliver
attempts
specifies the number of attempts overall to remove slivers.
iterations
specifies the number of iterations to be performed for the specific sliver removal operation.
low-skew
operation will attempt to improve cells with skewness above the low-skew value specified,
but there will be no attempt to reduce the skewness below the specified value. A limited set
of improve operations will be used as compared to the operations required for the skew value-
based improvement.
method
enables you to select the method for sliver removal. The default method used is the fast
method. The fast and the aggressive methods use the same controls and give similar
results for good quality surface meshes. In case of poor surface meshes, the aggressive
method will typically succeed in improving the mesh to a greater extent, but it may be slower
than the fast method.
remove?
enables/disables the automatic removal of slivers.
skew
specifies the skewness threshold for sliver removal.
skewness-method/
enters the skewness refinement controls menu.
levels
specifies the number of refinement levels for skewness-based refinement.
max-skew-improve?
enables/disables the skewness-based improvement during refinement.
must-improve-skewness?
enables/disables the modification of the default auto refinement parameters in order to improve
skewness after refinement.
refine-boundary-cells?
enables/disables the automatic refinement of boundary cells during refinement.
refine-cells?
enables/disables the automatic refinement of cells during refinement.
skew-improve/
contains options for improving refinement by the skewness method. This sub-menu is available
when max-skew-improve? is enabled.
mesh/
attempts
specifies the number of overall improvement attempts for the skewness method.
boundary-sliver-skew
specifies the boundary sliver skewness for the skewness method. This parameter is used
for removing sliver cells along the boundary.
iterations
specifies the number of improvement iterations in each attempt for the skewness method.
sliver-skew
specifies the sliver skewness for the skewness method. This parameter is used for removing
sliver cells in the interior.
target-low-skew
operation will attempt to improve cells with skewness above the target-low-skew
value specified, but there will be no attempt to reduce the skewness below the specified
value. A limited set of improve operations will be used as compared to the operations re-
quired for the target-skew value-based improvement. The value specified could be
approximately 0.1 lower than the target-skew value.
target-skew
specifies the targeted skewness during improvement for the skewness method.
target?
enables you to enable targeted skewness-based refinement for the skewness method. This
enables you to improve the mesh until the targeted skewness value is achieved.
smooth-mesh?
enables/disables the automatic smoothing of the mesh during refinement.
sort-boundary-faces?
enables/disables the automatic sorting of boundary faces by size during refinement.
sort-cells?
enables/disables the automatic reverse sorting of cells by skewness during refinement.
swap-faces?
enables/disables the automatic swapping of faces during refinement.
type
enables you to select the appropriate pre-defined skewness refinement parameters. You can
select default, fast-transition, or incremental-improve as required.
use-max-cell-size?
enables you to use the maximum cell size specified instead of recomputing the value based on
the objects, when the volume mesh is generated. This option is disabled by default.
delete-virtual-cells
deletes virtual cells created due to the use of the keep-virtual-entities? option.
improve/
enters the tet improve menu.
collapse-slivers
attempts to collapse the nodes of a skewed sliver cell on any one of its neighbors.
improve-cells
improves skewed tetrahedral cells.
refine-boundary-slivers
attempts to increase the volume of boundary slivers to create a valid tet cell. Tetrahedra having
one or two faces on the boundary are identified and then the appropriate edge split. The split
node is then smoothed such that the volume of the tetrahedron increases, thereby creating a valid
tet cell.
refine-slivers
attempts to remove the sliver by placing a node at or near the centroid of the sliver cell. Swapping
and smoothing are performed to improve the skewness. You can also specify whether boundary
cells are to be refined. Refining the boundary cells may enable you to carry out further improvement
options such as smoothing, swapping, and collapsing slivers.
skew-smooth-nodes
applies skewness-based smoothing to nodes on the tetrahedral cell zones to improve the mesh
quality.
sliver-boundary-swap
removes boundary slivers by moving the boundary to exclude the cells from the zone.
smooth-boundary-sliver
smooths nodes on sliver cells having all four nodes on the boundary until the skewness value is
less than the specified value. The default values for the skewness threshold, minimum dihedral
angle between boundary faces, and feature angle are 0.985, 10, and 30, respectively.
smooth-interior-sliver
smooths non-boundary nodes on sliver cells having skewness greater than the specified threshold
value. The default value for the skewness threshold is 0.985.
smooth-nodes
enables you to apply either Laplacian or variational smoothing to nodes on the tetrahedral cell
zones to improve the mesh quality.
swap-faces
performs interior face swapping to improve cell skewness.
init
generates the initial Delaunay mesh by meshing the boundary nodes.
init-refine
generates the tetrahedral mesh.
local-regions/
activate
activates the specified regions for refinement.
mesh/
deactivate
deactivates the specified regions for refinement.
define
delete
ideal-vol
reports the volume of an ideal tetrahedron for the edge length specified.
init
defines the default refinement region encompassing the entire geometry.
list-all-regions
lists all refinement region parameters and the activated regions in the console.
refine
refines the active cells inside the selected region based on the specified refinement parameters.
preserve-cell-zone
allows you to specify the cell zones to be preserved during the meshing process.
refine
refines the initialized mesh.
trace-path-between-cells
detects holes in the geometry by tracing the path between the two specified cells
thin-volume-mesh/
creates a sweep-like mesh for a body occupying a thin gap. You define source and target boundary faces
zones (the source face normal should point to the target). The source face mesh may be triangles or quads.
create
initiates the dialog box to specify source and target faces and specify the following parameters
Gap Thickness
helps Fluent Mesher determine the region to be remeshed. If set to 0, the mesher will automatically
calculate the gap thickness. If non-zero, the Gap Thickness defines the maximum separation
between source and target zones in the swept-mesh region (default = 0).
Number of Divisions
specifies the number of layers created between source and target faces (default = 1).
Growth Rate
specifies the maximum thickness ratio between two adjacent layers (default = 1).
Remesh Overlap Zones

if yes, any overlapped part of the surface mesh on the target and adjacent faces will be remeshed.
Original meshes are replaced (default = yes).
An example create dialog box:
Meshing/mesh/thin-volume-mesh/create
()
Source face zones(1) [()] source*
Source face zones(2) [()]
()
Target face zones(1) [()] target
Target face zones(2) [()]
Gap Thickness [0] 1
Number of Divisions [1] 5
Growth Rate [1]
Remesh Overlap Zones? [yes]
Start thin-gap mesh:
- Create and project nodes and faces on targets …
- Project nodes on targets ...
- Create layer nodes ...
- Create side quad faces ...
- Create interior layer cells ...
- Retriangluate target face zones ...
- Retriangulate adjacent face zones ...
Done
Chapter 9: objects/
cad-association/
contains options for modifying the selected objects based on the associated CAD entities and attaching/de-
taching the CAD entities from the objects. This menu is available when the CAD Assemblies tree is created
during CAD import.
attach-cad
attaches CAD entities to the selected geometry/mesh objects. Select the geometry/mesh objects and
specify the path for the CAD entities to be associated with the objects. The selected geometry/mesh
objects will be associated with the CAD entities which will then be locked.
detach-all-objects
detaches all the CAD objects associated with the geometry/mesh objects. Specify the type of objects
(geom or mesh) to be detached. All association will be removed and the geometry/mesh objects will
be independent of changes to the CAD entities.
detach-objects
detaches the CAD objects associated with the specified geometry/mesh objects. All association will
be removed and the selected geometry/mesh objects will be independent of changes to the CAD en-
tities.
query-object-association
returns a list of the CAD entities associated with the objects selected.
restore-cad
restores the geometry/mesh objects from the associated CAD objects.
unlock-cad
unlocks the CAD objects associated with the selected geometry/mesh objects.
update-objects
updates the specified geometry/mesh objects based on changes to the associated CAD objects.
update-all-objects
updates all geometry/mesh objects based on changes to the associated CAD objects. Specify the type
of objects (geom or mesh) to be updated.
change-object-type
allows you to change the object type (geom, or mesh).
check-mesh
checks the mesh on the specified objects for connectivity and orientation of faces. The domain extents,
volume statistics, and face area statistics will be reported along with the results of other checks on the
mesh.
objects/
create
creates the object based on the priority, cell zone type, face zone(s), edge zone(s), and object type specified.
You can specify the object name or retain the default blank entry to have the object name generated
automatically.
create-and-activate-domain
creates and activates the domain comprising the face zone(s) from the object(s) specified.
create-groups
creates a face group and an edge group comprising the face zone(s) and edge zone(s) included in the
specified object(s), respectively.
create-intersection-loops
allows you to create intersection loops for objects.
• The collectively option creates an interior edge loop at the intersection between two adjacent
face zones included in the same object and between multiple objects.
• The individually option creates an interior edge loop at the intersection between two adjacent
face zones included in the same object.
create-multiple
creates multiple objects by creating an object per face zone specified. The objects will be named automat-
ically based on the prefix and priority specified.
create-new-mesh-object/
contains options for creating a new mesh object by wrapping or remeshing existing objects.
remesh
creates a new mesh object by remeshing geometry objects individually or collectively.
wrap
creates a new mesh object by wrapping the specified objects individually or collectively.
delete
deletes the specified object(s).
delete-all
deletes all the defined objects.
delete-all-geom
deletes all the defined geom objects.
delete-unreferenced-faces-and-edges
deletes all the faces and edges that are not included in any defined objects.
extract-edges
extracts the edge zone(s) from the face zone(s) included in the specified object(s), based on the edge-
feature-angle value specified (/objects/set/set-edge-feature-angle).
improve-feature-capture
enables you to imprint the edges comprising the object on to the object face zones to improve feature
capture for mesh objects. You can specify the number of imprinting iterations to be performed.
Note:
The geometry objects used to create the mesh objects should be available when the
improve-feature-capture command is invoked. Additionally, the face zones
comprising the objects should be of type other than geometry.
improve-object-quality
enables you to improve the surface mesh quality for mesh objects. Select the mesh objects and the
method for improving the surface mesh. The smooth-and-improve method improves the mesh by a
combination of smoothing, swapping, and surface mesh improvement operations. Object normals are
correctly oriented and island faces are also deleted. You can optionally coarsen the surface mesh by spe-
cifying a suitable coarsening factor. Additional imprinting operations can be done to improve feature
capture on the surface mesh. The surface-remesh method improves the mesh by remeshing based
on the current size field. Object normals are correctly oriented and island faces are also deleted.
join-intersect/
contains options for connecting overlapping and intersecting face zones.
add-objects-to-mesh-object
allows you to specify one or more mesh objects to be added to an existing mesh object.
change-region-type
allows you to select a cell zone type (solid, fluid or dead) for a specific region.
compute-regions
closed cell zone regions are computed from the specified mesh object. You may include a material
point, if desired.
controls/
remesh-post-intersection?
used to enable or disable automatic post-remesh operation after join or intersect.
create-mesh-object
allows you to specify one or more mesh objects to be connected in one mesh object.
delete-region
removes a closed cell zone region and all of its face zones, except those which are shared by other
regions, from the specified mesh object.
intersect
connects two intersecting face zones within specified angle and tolerance.
join
connects two overlapping face zones within specified angle and tolerance.
list-regions
lists details of region type, volume, material point, and comprising face zones for the topological regions
computed for the specified mesh object.
objects/
merge-regions
specified regions are joined into a single region.
rename-region
enables you to specify a new name for a specified region.
labels/
contains options for creating and managing face zone labels.
add-zones
adds the specified face zones to the existing face zone label for an object.
create
creates a new face zone label for the specified face zones.
create-label-per-object
creates a new face zone label for all the face zones in every object.
create-label-per-zone
creates a new face zone label for each face zone in the object.
delete
deletes the specified face zone labels.
label-unlabeled-zones
creates labels for unlabeled face zones within the specified object. You can either use the object name
as the label or provide your own label.
merge
merges the specified face zone labels to a single label with the name specified.
remove-all-labels-on-zones
removes all the face zone labels for the specified face zones. This command is applicable to geometry
objects only.
remove-zones
removes the specified face zones from the existing face zone label for an object.
rename
renames the specified face zone label.
list
lists details such as cell zone type, priority, object type, comprising face and edge zones, and object reference
point for all the defined objects.
merge
merges the specified objects into a single object.
merge-edges
merges all the edge zones in an object into a single edge zone.
Note:
If the object is composed of edge zones of different types (boundary and interior), the
edge zones of the same type (boundary or interior) will be merged into a single edge
zone.
merge-nodes
merges the free nodes at the object level based on the specified tolerance or using a tolerance that is a
specified percentage of shortest connected edge length.
merge-voids
allows you to merge voids in the mesh object after the sewing operation.
merge-walls
merges all the face zones of type wall in an object into a single face zone.
remove-gaps/
contains options for removing gaps between the mesh objects specified or removing the thickness in the
mesh objects specified.
ignore-orientation?
allows you to set whether the orientation of the normals should be taken into account while identifying
the gap to be removed.
remove-gaps
allows you to remove gaps between the mesh objects specified or remove the thickness in the mesh
objects specified. Select the appropriate repair option and specify the other parameters required.
show-gaps
marks the faces at the gap between mesh objects based on the gap distance and percentage margin
specified.
rename-cell-zone-boundaries-using-labels
renames the boundaries of the cell zones based on the existing face zone labels. This allows for the cell
zone boundaries in solution mode to have names corresponding to the face zone labels in meshing mode.
Note:
This command will not work if you read in a volume mesh generated in a version prior
to release 16.2. In such cases, regenerate the volume mesh before using the command.
, rename-object
allows you to rename a specified geometry or mesh object with another specified name.
rename-object-zones
renames the face and edge zones comprising the object based on the object name. You can also specify
the separator to be used.
objects/
restore-faces
restores the mesh object surface mesh from the backup created. The current mesh object face zones and
cell zones will be deleted.
If the object backup is disabled (/mesh/auto-mesh-controls/backup-object no), you

will not be able to restore the surface mesh using this command.
Note:
There may be a difference in the initial volume mesh generated for an object and that
generated after restoring the object surface mesh due to differences in the order of
zones/entities processed during volume meshing.
rotate
rotates the object(s) based on the angle of rotation, pivot point, and axis of rotation specified.
scale
scales the object(s) based on the scale factors specified.
separate-faces-by-angle
separates the face zone(s) comprising the object based on the angle specified.
separate-faces-by-seed
separates the face zone(s) comprising the object based on the seed face specified.
set/
contains options for setting additional object-related settings.
set-edge-feature-angle
sets the edge feature angle to be used for extracting edge zone(s) from the face zone(s) included in
the object(s).
show-edge-zones?
displays the edge zone(s) comprising the object(s) drawn in the graphics window.
show-face-zones?
displays the face zone(s) comprising the object(s) drawn in the graphics window.
sew/
contains options related to the object sewing operation.
Note:
sew
connects the mesh objects to generate the conformal surface mesh.
set/
contains additional options related to the object sewing operation.
include-thin-cut-edges-and-faces
allows better recovery of thin region configurations during the sewing operation.
process-slits-as-baffles?
allows you to collapse the nearly overlapping surfaces corresponding to the baffle when the sew
operation is performed to create the mesh object. Specify the maximum slit thickness relative to
the minimum size specified and the parallel face angle between the faces comprising the slit when
process-slits-as-baffles is enabled.
zone-name-prefix
allows you to specify a prefix for the zones included in the mesh object created using the sew op-
eration.
, summary
allows you to obtain a summary of a specified geometry or mesh object, or obtain a summary of all geometry
or mesh objects.
translate
translates the object(s) based on the translation offsets specified.
update
allows you to update the objects defined when the face and/or edge zone(s) comprising the object have
been deleted.
volumetric-regions/
contains options for manipulating volumetric regions and generating the volume mesh.
auto-fill-volume
creates the volume mesh for the selected volumetric regions based on the meshing parameters set.
change-type
enables you to change the region type.
compute
computes the volumetric regions based on the face zone labels. You can choose to use existing mater-
ial points for computing the regions.
Note:
When regions are computed, region names and types will be based on the face zone
labels of the mesh object selected. If regions are recomputed, all previous region
names and types will be over written.
delete
deletes the specified volumetric regions.
Tip:
Deleting regions may cause face zones to be deleted. It is recommended that the
region type be changed to dead instead of deleting the region.
delete-cells
deletes the cell zones of the specified regions.
hexcore/
contains options for setting hexcore mesh controls.
objects/
list
prints region information to the console, including type, volume, material point and face zones.
merge
merges specified regions in to a single region.
Note:
If there are shared face zones, merging regions will delete the shared face zones.
However, if there are cell zones associated with the regions, then merging the regions
will not delete the shared face zones. In this case, the shared face zones will be deleted
when the cell zones are deleted.
rename
renames the region.
scoped-prism/
contains options for setting scoped prism controls.
tet/
contains options for setting tetrahedral mesh controls.
update
recomputes the selected volumetric region(s) while preserving the region name(s) and type(s).
wrap/
contains options related to the object wrapping operation.
check-holes
allows you to check for holes in the objects. The number of hole faces marked will be reported.
recover-periodic-surfaces
allows you to reestablish the periodic relationship between master and shadow face zones on the
mesh object. You will be prompted for the method and to identify the periodic face zones to be re-
covered.
auto
performs the automatic periodic recovery method using either the master or shadow periodic face
zones. Periodic recovery will be attempted in both directions without additional prompting.
manual
performs the manual periodic recovery method. You will be prompted for periodic and shadow
face zones, and for the periodic source. The periodic source may be from an underlying periodic
geometry surface or manual entry of the rotational periodic parameters (angle, origin, axis).
Note:

currently.
set/
contains additional options related to the object wrapping operation.
add-geometry-recovery-level-to-zones
enables you to set the geometry recovery level (high or low) for the specified face zones.
include-thin-cut-edges-and-faces
allows better recovery of thin region configurations during the object wrapping operation.
list-zones-geometry-recovery-levels
lists the zones based on geometry recovery level specified.
max-free-edges-for-hole-patching
allows you to set the maximum number of free edges in a loop to fill the holes.
minimum-relative-topo-area
specifies the minimum relative topological area for shrink wrapping.
minimum-relative-topo-count
specifies the minimum relative topological count for shrink wrapping.
minimum-topo-area
specifies the minimum topological area for shrink wrapping.
minimum-topo-count
specifies the minimum topological count for shrink wrapping.
relative-feature-tolerance
specifies the relative feature tolerance for shrink wrapping.
report-holes?
allows you to check for holes in the mesh object created. Holes, if any will be reported at the end
of the object wrapping operation.
resolution-factor
sets the resolution factor for shrink wrapping. This option can be used to set sampling coarser or
finer than the final surface mesh.
shrink-wrap-rezone-parameters
allows you to set the parameters for improving the mesh object surface quality using rezoning.
The geometry object zones will be separated based on the separation angle specified to improve
the feature imprinting on the mesh object.
zone-name-prefix
allows you to specify a prefix for the zones included in the mesh object created using the object
wrapping operation.
wrap
creates the mesh objects based on the geometry objects selected and other object wrapping parameters
specified.
Chapter 10: parallel/
agglomerate
recombines distributed mesh data into a single partition on compute node 0.
auto-partition?
automatically partitions face-zones for parallel meshing.
distribute
allocates mesh to the compute nodes based on the computed partitions.
print-partition-info
displays computed partition data to the console.
spawn-solver-processes
specifies the number of solver processes. Additional processes will be spawned as necessary when
switching to solution mode. You will also be prompted for (Linux and mixed Windows/Linux) interconnect
type, machine list or host file, and (Linux and mixed Windows/Linux) option to be used.
thread-number-control
controls the maximum number of threads on each machine.
Chapter 11: report/
boundary-cell-quality
reports the number and quality limits of boundary cells containing the specified number of boundary
faces. If you specify zero for number of boundary faces, you will be prompted for number of
boundary nodes.
cell-distribution
reports the distribution of cell quality or size based on the bounding limits and number of partitions spe-
cified.
cell-quality-limits
reports the cell quality limits.
cell-size-limits
reports the cell size limits.
cell-zone-at-location
returns the cell zone at or closest to the specified location.
cell-zone-volume
reports the volume of the specified cell zone.
edge-size-limits
reports the edge size limits.
face-distribution
reports the distribution of face quality or size based on the bounding limits and number of partitions
specified.
face-node-degree-distribution
reports the distribution of boundary faces based on face node degree. The node degree is the number of
faces connected to the node. Specify the list of boundary face zones and the minimum and maximum face
node degree to be reported. You can also consider only internal nodes, if required.
face-quality-limits
reports the face quality limits.
face-size-limits
reports the face size limits.
face-zone-area
reports the area of the specified face zone.
face-zone-at-location
reports the face zone at the given location.
report/
list-cell-quality
reports a list of cells with the specified quality measure within a specified range. The valid prefixes are bn
(boundary node), n (node), bf (boundary face), f (face), and c (cell).
memory-usage
reports the amount of memory used for all nodes, faces, and cells, and the total memory allocated.
mesh-size
reports the number of nodes, faces, and cells in the mesh.
mesh-statistics
writes mesh statistics (such as zone information, number of cells, faces, and nodes, range of quality and
size) to an external file.
neighborhood-quality
reports the maximum skewness, aspect ratio, or size change of all cells using a specified node.
number-meshed
reports the number of elements that have been meshed.
print-info
prints information about individual components of the mesh. This command also appears in the boundary
menu. When you use this command, you will be prompted for an “entity” (that is, a node, face, or cell). An
entity name consists of a prefix and an index. For a description of the displayed information see Reporting
Mesh Information in the Fluent User's Guide
quality-method
specifies the method to be used for reporting face and cell quality.
unrefined-cells
reports the number of cells that have not been refined.
update-bounding-box
updates the bounding box.
verbosity-level
specifies how much information should be displayed during mesh initialization, refinement and other
operations. Changing the value to 2 from the default value of 1 will produce more messages, while changing
it to 0 will disable all messages.
Chapter 12: scoped-sizing/
compute
computes the size field based on the defined size functions and/or scoped size controls.
create
defines the scoped size based on the specified parameters.
delete
deletes the specified scoped size controls.
delete-all
deletes all the defined scoped size controls.
delete-size-field
deletes the current size field.
list
lists all the defined scoped size controls and the corresponding parameter values defined.
list-zones-uncovered-by-controls
lists the zones for which no scoped sizing controls have been defined.
modify
modifies the scoped size control definition.
read
enables you to read in a scoped sizing file (*.szcontrol).
validate
validates the scoped sizing controls defined. An error will be reported if the scoped sizing controls do not
exist or the scope for one (or more) controls is invalid.
write
enables you to write a scoped sizing file (*.szcontrol).
Chapter 13: size-functions/
Size functions can be defined using the commands in the size-functions menu. The command
size-functions/create enables you to define size functions. You need to specify the size function
type, whether face or edge zones are to be used, the boundary or edge zones for which the size function
is to be defined, the size function name, and the parameters relevant to the size function type. You can
also have the name generated automatically by retaining the default entry for the size function name.
The size function name will be assigned based on the zone type (face or edge) and the size function
type (for example, the size function face-curvature-sf-5 indicates that the curvature size function is
defined for face zones. The size function ID is 5.)
An example is
size-functions/create curvature face wall:x wall:y, curv-size-function 0.01 0.1 1.2 5
where, curvature is the size function type, face indicates that face zones are to be used, wall:x,
wall:y indicate the boundary zones for which the size function is defined, and curv-size-function
is the size function name. The remaining values correspond to the parameters for the curvature size
function, that is, minimum and maximum size, growth rate, and normal angle.
Note:
All boundary face zones and edge zones included in the global domain are available for
defining size functions, even if a local domain has been activated.
compute
computes the size function based on the defined parameters.
contours/
contains options for managing contours.
draw
displays contours in the graphics window. Run compute prior to contours/draw.
set/
contains options to manage the contour size.
refine-facets?
allows you to specify smaller facets if the original are too large. Default is no.
create
create-defaults
size-functions/
delete
delete-all
disable-periodicity-filter
enable-periodicity-filter
applies periodicity to the size field.
Specify the angle, pivot, and axis of rotation to set up periodicity.
If periodicity has been previously defined, the existing settings will be applied.
Note:
Only rotational periodicity is supported, translational periodicity is not supported currently.
list
lists all the defined size functions and the corresponding parameter values defined.
resets the global controls to their default values.
set-global-controls
sets the values for the global minimum and maximum size, and the growth rate.
Note:
If you set the global minimum size to a value greater than the local minimum size defined
for existing proximity, curvature, or hard size functions, a warning will appear, indicating
that the global minimum size cannot be greater than the specified local minimum size.
sets the tolerance relative to minimum size to take gaps into account. Gaps whose thickness is less than
the global minimum size multiplied by this factor will not be regarded as a proximity gap.
set-scaling-filter
allows you specify the scale factor, and minimum and maximum size values to filter the size output from
the size field.
identifies the zones comprising non-triangular elements and uses a triangulated copy of these zones for
computing the size functions.
allows you to disable curvature data from the nodes of the CAD facets.
Chapter 14: switch-to-solution-mode
switch-to-solution-mode
enables you to transfer the mesh data from meshing mode to solution mode in ANSYS Fluent. When you
use the switch-to-solution-mode command, you will be asked to confirm that you want to switch
to solution mode.
Appendix A. Query and Utility Functions
The following sections describe the query and utility functions available:
A.1. List Queries and Utility Functions
A.2. Label Utility Functions
A.3. Report Utility Functions
A.4. Diagnostic Based Marking Utility Functions
A.5. Mesh Setup Utility Functions
A.6. Mesh Operation Utility Functions
A.7. Miscellaneous Functions
A.1. List Queries and Utility Functions

When performing a series of operations, you may want to list all the zones of a particular type, group,
or containing a particular text string or name pattern. You can also query zones through the TUI based
on a regular expression and a specified variable. You can:
• Identify face/cell zones closest to a specified location.
• Identify zones/objects of a specific type or containing a particular text string. You can also identify zones
belonging to a group or object.
• Obtain object region and face zone label lists.
• Obtain mesh setup information such as zones with prism mesh settings or prism controls defined
• Use the utility functions to determine the zones created during a particular operation by performing Boolean
operations on lists returned by specific functions.
• Use the eval-expr function to evaluate the lists returned by the functions in order that they can be used
as input in the text user interface commands.
Note:
These functions are not supported in a distributed parallel environment.
Query and Utility Functions
Feature Description Utility Function

Zone By location Return face zone at or closest to a (get-face-zone-at-location
query specified location. '(x y z))
Note:
This function is not

applicable to
polyhedra meshes.
Return cell zone at or closest to a (get-cell-zone-at-location

specified location '(x y z))
Zone lists By zone Return a list of zones of the specified (get-zones-of-type 'type)
type default zone type
By default Return a list of zones of the specified (get-zones-of-group 'group)
group default zone group or user-defined
group
By filter Return a list of zones whose names (get-face-zones-of-filter
string contain the specified filter string 'filter)
(get-cell-zones-of-filter
'filter)
(get-edge-zones-of-filter
'filter)
(get-node-zones-of-filter
'filter)
By object Return a list of face zones in the (get-face-zones-of-objects
specified objects '(object-list))
Return a list of face zones by ID in the (tgapi-util-get-face-zone-
specified object id-list-of-object 'object)
(tgapi-util-get-face-zone-
id-list-of-object "object")
specified regions of an object id-list-of-regions 'object
'(region-list))
id-list-of-regions "object"
'(region-list))
Return a list of edge zones in the (get-edge-zones-of-objects
specified objects '(object-list))
Return a list of edge zones by ID in (tgapi-util-get-edge-zone-
the specified object id-list-of-object 'object)
(tgapi-util-get-edge-zone-
Return a list of cell zones by ID in the (tgapi-util-get-cell-zone-
specified object id-list-of-object 'object)
List Queries and Utility Functions

(tgapi-util-get-cell-zone-
Return a list of face zones in the (get-face-zones-of-labels
specified face zone labels of the 'object '(list-of-label-
object specified names))
specified face zone labels of an object id-list-of-labels 'object
'(face-zone-label-list))
id-list-of-labels "object"
Return a list of face zones shared by (get-face-zones-shared-by-
regions of specified types in the mesh regions-of-type 'mesh-ob-
object specified, where region- ject 'region-type)
type is fluid-fluid, solid-
solid, or fluid-solid
Return a list of face zones in the (get-face-zones-of-regions
specified regions 'object '(list-of-region-
names))
By cell Return a list of prism cell zones (tgapi-util-get-prism-cell-
shape zones '(zone-list))
(tgapi-util-get-prism-cell-
zones "zone-name-pattern*")
Return a list of tet cell zones (tgapi-util-get-tet-cell-
zones '(zone-list))
(tgapi-util-get-tet-cell-
By Return adjacent cell zones for given (tgapi-util-get-adjacent-
connectivity face zone cell-zones zone-id)
(tgapi-util-get-adjacent-
cell-zones 'zone-name)
cell-zones "zone-name")
Return adjacent boundary face zones (tgapi-util-get-adjacent-
for given cell zones. face-zones '(cell-zone-
list))
face-zones "cell-zone-name-
pattern*")
Return adjacent interior and boundary (tgapi-util-get-adjacent-
face zones for given cell zones. interior-and-boundary-face-
zones '(cell-zone-list))
interior-and-boundary-face-

zones "cell-zone-name-pat-
tern*")
Return adjacent zones based on edge (tgapi-util-get-adjacent-
connectivity zones-by-edge-connectivity
'(zone-list))
zones-by-edge-connectivity
"zone-name-pattern*")
Return adjacent zones based on node (tgapi-util-get-adjacent-
connectivity zones-by-node-connectivity
'(zone-list))
zones-by-node-connectivity
Returns the number of faces and the (tgapi-util-get-shared-
boundary face zones that are shared boundary-zones 'cell-zone-
with the specified cell zones. name)
(tgapi-util-get-shared-
boundary-zones '(cell-zone-
list))
(tgapi-util-get-shared-
boundary-zones "cell-zone-
name-pattern*")
Returns interior face zones connected (tgapi-util-get-interior-
to given cell zones. zones-connected-to-cell-
zones '(cell-zone-list))
(tgapi-util-get-interior-
zones-connected-to-cell-
tern*")
Mesh setup Return a list of face zones with (tgapi-util-get-face-zones-
zone-specific prism settings applied with-zone-specific-prisms-
applied)
Return a list of face zones to which (tgapi-util-get-face-zones-
the specified prism controls apply of-prism-controls "control-
name")
Return the baffle zones based on the (tgapi-util-get-baffles
face zone list specified '(face-zone-list))
Return the embedded baffle zones (tgapi-util-get-embedded-
baffles)
Wrapped Return a list of wrapped face zones (get-wrapped-zones)
zones
Unreferenced Return a list of unreferenced zones (get-unreferenced-edge-
zones zones)

(get-unreferenced-face-
zones)
(get-unreferenced-cell-
zones)
Return a list of unreferenced zones (get-unreferenced-edge-
whose names contain the specified zones-of-filter 'filter)
filter string (get-unreferenced-face-
zones-of-filter 'filter)
(get-unreferenced-cell-
zones-of-filter 'filter)
Return a list of unreferenced zones (tgapi-util-get-unrefer-
by ID, whose names contain the enced-face-zone-id-list-of-
specified pattern pattern "pattern*")
(tgapi-util-get-unrefer-
enced-cell-zone-id-list-of-
pattern "pattern*")
(tgapi-util-get-unrefer-
enced-edge-zone-id-list-of-
pattern "pattern*")
Mesh Return cell zone with maximum (tgapi-util-get-maxsize-
statistics volume for given list or pattern of cell cell-zone-by-volume "pat-
zones tern*")
(tgapi-util-get-maxsize-
cell-zone-by-volume '(zone-
list))
Return cell zone with maximum count (tgapi-util-get-maxsize-
of elements for given list or pattern cell-zone-by-count "pat-
of cell zones tern*")
(tgapi-util-get-maxsize-
cell-zone-by-count '(zone-
list))
Return face zone with minimum area (tgapi-util-get-minsize-
for given list or pattern of face zones face-zone-by-area "pat-
tern*")
(tgapi-util-get-minsize-
face-zone-by-area '(zone-
list))
Return face zone with minimum count (tgapi-util-get-minsize-
of elements for given list or pattern face-zone-by-count "pat-
of face zones tern*")
(tgapi-util-get-minsize-
face-zone-by-count '(zone-
list))
Return a list of face zones with a (tgapi-util-get-face-zone-
count below the maximum entity list-by-maximum-entity-

count (maximum-entity-count) count maximum-entity-count
specified. You can choose to restrict only-boundary?)
the report to only boundary face
zones, if required (only-boundary?
set to #t or #f).
Return a list of edge zones with a (tgapi-util-get-edge-zone-
count below the maximum entity list-by-maximum-entity-
count (maximum-entity-count) count maximum-entity-count
specified. You can choose to restrict only-boundary?)
the report to only boundary edge
zones, if required (only-boundary?
set to #t or #f).
Return a list of cell zones with a count (tgapi-util-get-cell-zone-
below the maximum entity count list-by-maximum-entity-
(maximum-entity-count) count maximum-entity-count)
specified.
maximum zone area below the max- list-by-maximum-zone-area
imum-zone-area specified. maximum-zone-area)
minimum zone area above the min- list-by-minimum-zone-area
imum-zone-area specified. minimum-zone-area)
Mesh Return a list of zones with free faces (tgapi-util-get-zones-with-
diagnostics for the face zones specified free-faces '(zone-id-list))
(tgapi-util-get-zones-with-
free-faces '(zone-name-
list))
free-faces "zone-name-pat-
tern*")
Return a list of zones with (tgapi-util-get-zones-with-
multi-connected faces for the face multi-faces '(zone-id-
zones specified list))
multi-faces '(zone-name-
list))
multi-faces "zone-name-pat-
tern*")
Return a list of overlapping face zones (tgapi-util-get-overlap-
based on the area-tolerance and ping-face-zones "face-zone-
distance-tolerance specified name-pattern*" area-toler-
ance distance-tolerance)
Return a list of zones with marked (tgapi-util-get-zones-with-
faces for the face zones specified marked-faces '(zone-id-
list))

marked-faces '(zone-name-
list))
marked-faces "zone-name-
pattern*")
Object By name Return a list of all objects (tgapi-util-get-all-object-
lists name-list)
By type Return a list of objects of the specified (get-objects-of-type 'type)
type (tgapi-util-get-object-
name-list-of-type 'type)
By filter Return a list of objects whose names (get-objects-of-filter
contain the specified filter string 'filter)
Region By object Return a list of regions in the (get-regions-of-object 'ob-
lists specified object ject)
(tgapi-util-get-region-
name-list-of-object 'ob-
ject)
name-list-of-object "ob-
ject")
By filter Return a list of regions in the (get-regions-of-filter 'ob-
specified object, whose names ject 'filter)
contain the specified filter string
By name Return a list of regions in the (tgapi-util-get-region-
pattern specified object, whose names name-list-of-pattern 'ob-
contain the specified name pattern ject "region-name-pat-
tern*")
name-list-of-pattern "ob-
ject" "region-name-pat-
tern*")
By face Return a list of regions containing the (get-regions-of-face-zones
zones face zones specified '(list-of-face-zone-IDs))
name-list-of-face-zones
'(list-of-face-zone-IDs))
name-list-of-face-zones
"face-zone-name-pattern*")

Overlapping Based on Return the pairs of overlapping face (tgapi-util-find-join-pairs
zone pairs join zones based on the join tolerance and '(face-zone-name-list)
tolerance feature angle. join-tolerance absolute-
and feature tolerance? join-angle)
angle • Specify the face zones using a
(tgapi-util-find-join-pairs
face-zone-name-list, face-
'(face-zone-id-list) join-
zone-ID-list, or face-zone-
tolerance absolute-toler-
name-pattern*.
ance? join-angle)
• Specify the tolerance value for (tgapi-util-find-join-pairs
locating the overlapping faces "face-zone-name-pattern*"
(join-tolerance). join-tolerance absolute-
tolerance? join-angle)
• Choose to use an absolute tolerance
value or relative to face edges (set
absolute-tolerance to #t or
#f).
• Specify the feature angle to identify

features in the overlap region
(feature-angle). The default
value is 40.
Each member in the list returned

includes the zone IDs for the
overlapping zone pair and the
join region represented by the
bounding box. The same pair of
zones may appear multiple times
(with different join region
bounding box coordinates) in the
returned list.
The returned list is of the format:

((pair1_zone-id1
pair1_zone-id2 (join-re-
gion-bounding-box-min x y
z) (join-region-bounding-
box-max x y z))
(pair2_zone-id1 pair2_zone-
id2 (join-region-bounding-
box-min x y z) (join-re-
gion-bounding-box-max x y
z)) ...)
For example:
((2 5 (-211.40 -139.24 -
165.17) (46.36 -101.69 -
124.61)) (2 5 (-211.4 -
204.94 -55.89) (46.29 -
171.68 -12.16)) (7 8 (-

170.82 140.79 -108.57)
(5.83 162.47 -89.04)))
List Convert Convert a list of zone name symbols (tgapi-util-convert-zone-
operations to a list of IDs name-symbols-to-ids '(zone-
name-list))
Convert a list of zone name strings to (tgapi-util-convert-zone-
a list IDs name-strings-to-ids '(zone-
name-list))
Convert a list of zone IDs to a list of (tgapi-util-convert-zone-
name strings ids-to-name-strings '(zone-
id-list))
Convert a list of zone IDs to a list of (tgapi-util-convert-zone-
name symbols ids-to-name-symbols '(zone-
id-list))
Convert a list of symbols to strings (tgapi-util-convert-symbol-
list-to-string '(symbol-
list))
Create a string from a list of symbols (tgapi-util-create-string-
from-symbol-list '(symbol-
list))
Subtract Returns the boolean subtraction of (tgapi-util-integer-list-
the lists subtract '(list-1) '(list-
2))
Replace Enables you to replace one element (tgapi-util-list-replace
in a list by another new-element old-element
input-list)
Remove Enables you to remove an element (tgapi-util-remove-element-
from a list from-list input-list ele-
ment)
Search Enables you to search for an element (tgapi-util-list-contains?
in a list. input-list element)
A.1.1. Using Boolean Operations with Lists

You can perform Boolean operations on lists returned by the query functions:
• Union of lists: (list-union list-1 list-2 ...)
• Intersection of lists: (list-intersection list-1 list-2 ...)
• Subtraction of lists: (list-subtract list-1 list-2)
Note:
Only two lists can be used as arguments for the subtraction operation.
For example,
list-1 = '(1 2 3 4)
list-2 = '(1 5 6)
list-3 = '(1 4 7)
then:
(list-union list-1 list-2 list-3) = '(1 2 3 4 5 6 7)
(list-intersection list-1 list-2 list-3) = '(1)
(list-subtract list-1 list-2) = '(2 3 4)
A.1.2. Examples
• Smoothing the prism-cap zone created during the prism creation operation:
– Obtain a list of the zones named prism-cap*.
(define initial-zones(get-face-zones-of-filter 'prism-cap*))
– Apply appropriate prism parameters and create prisms.
– Obtain a list of the zones named prism-cap* after the prism creation operation.
(define final-zones(get-face-zones-of-filter 'prism-cap*))
– Smooth the recently created prism-cap zone.
/boundary/improve/smooth(eval-expr '(list-subtract final-zones ini-

tial-zones))
• Improving mesh object quality:
/objects/improve-object-quality (get-objects-of-type 'mesh) smooth-

and-improve 1 no
• Recovering periodic surfaces for mesh object face zones:
/boundary/recover-periodic-surfaces auto (get-face-zones-of-label

'_fluid '(periodic-1))
• Defining curvature sizing for all object face zones except symmetry planes:
/scoped-sizing/create control-curv curvature object-faces yes no

"(eval-expr ’(list-subtract (get-objects-of-filter '*) (get-objects-
of-filter 'sym*)))" 0.25 4 1.2 18
A.2. Label Utility Functions

The following label utility functions are available:
Label Utility Functions
Feature Description Function

Add On Add labels on the specified face zones. (tgapi-util-add-labels-on-face-
labels face zones '(face-zone-name-list)
zones • Specify the face zones using a face- '(label-name-list))
zone-name-list, face-zone-ID-
(tgapi-util-add-labels-on-face-
list, or face-zone-name-pat-
zones '(face-zone-ID-list)
tern*.
'(label-name-list))
• Specify the labels using a label-name- (tgapi-util-add-labels-on-face-
list (for example '(label1 la- zones "face-zone-name-pattern*"
bel2)). '(label-name-list))
On Add labels on the specified cell zones. (tgapi-util-add-labels-on-cell-

cell zones '(cell-zone-name-list)
zones • Specify the cell zones using a cell- '(label-name-list))
zone-name-list, cell-zone-ID-
(tgapi-util-add-labels-on-cell-
list, or cell-zone-name-pat-
zones '(cell-zone-ID-list)
tern*.
'(label-name-list))
• Specify the labels using a label-name- (tgapi-util-add-labels-on-cell-
list (for example '(label1 la- zones "cell-zone-name-pattern*"
On Add labels on the specified edge zones. (tgapi-util-add-labels-on-edge-

edge zones '(edge-zone-name-list)
zones • Specify the edge zones using an edge- '(label-name-list))
zone-name-list, edge-zone-ID-
(tgapi-util-add-labels-on-edge-
list, or edge-zone-name-pat-
zones '(edge-zone-ID-list)
tern*.
'(label-name-list))
• Specify the labels using a label-name- (tgapi-util-add-labels-on-edge-
list (for example '(label1 la- zones "edge-zone-name-pattern*"
Return On Returns the list of labels for the specified (tgapi-util-get-labels-on-face-

list of face face zones. Specify the face zones using a zones '(face-zone-name-list))
labels zones face-zone-name-list, face-zone- (tgapi-util-get-labels-on-face-
ID-list, or face-zone-name-pat- zones '(face-zone-ID-list))
tern*.
(tgapi-util-get-labels-on-face-
zones "face-zone-name-pat-
tern*")
On Returns the list of labels for the specified (tgapi-util-get-labels-on-cell-
cell cell zones. Specify the cell zones using a zones '(cell-zone-name-list))
zone cell-zone-name-list, cell-zone- (tgapi-util-get-labels-on-cell-
ID-list, or cell-zone-name-pat- zones '(cell-zone-ID-list))
tern*.
(tgapi-util-get-labels-on-cell-
tern*")

On Returns the list of labels for the specified (tgapi-util-get-labels-on-edge-
edge edge zones. Specify the edge zones using zones '(edge-zone-name-list))
zone an edge-zone-name-list, edge- (tgapi-util-get-labels-on-edge-
zone-ID-list, or edge-zone-name- zones '(edge-zone-ID-list))
pattern*.
(tgapi-util-get-labels-on-edge-
zones "edge-zone-name-pat-
tern*")
Face Return a list of face zone labels in the (get-labels-of-object 'object)
Zone specified object. (get-labels-of-object "object")
Label
lists (tgapi-util-get-all-label-name-
by list 'object)
object (tgapi-util-get-all-label-name-
list "object")
Return a list of face zone labels in the (get-labels-of-filter 'object
specified object, whose names contain the 'filter)
specified filter/pattern string. (tgapi-util-get-label-name-
list-of-pattern 'object "label-
name-pattern*")
(tgapi-util-get-label-name-
list-of-pattern "object" "la-
bel-name-pattern*")
Face Return a list of face zone labels containing (get-labels-of-face-zones
Zone the face zones specified. '(list-of-face-zone-IDs))
Label
lists
by
face
zones
Return Face Returns the list of face zones (by ID) (tgapi-util-get-face-zone-id-
list of zones containing the labels specified. list-with-labels '(face-zone-
zones name-list) '(label-name-list))
with • Specify the face zones using a face-
(tgapi-util-get-face-zone-id-
labels zone-name-list, face-zone-ID-
list-with-labels '(face-zone-
ID-list) '(label-name-list))
tern*.
(tgapi-util-get-face-zone-id-
• Specify the labels using a label-name- list-with-labels "face-zone-
list (for example '(label1 la- name-pattern* '(label-name-
bel2)). list))
Cell Returns the list of cell zones (by ID) (tgapi-util-get-cell-zone-id-

Zones containing the labels specified. list-with-labels '(cell-zone-
name-list) '(label-name-list))
• Specify the cell zones using a cell-
(tgapi-util-get-cell-zone-id-
list-with-labels '(cell-zone-
tern*.
Label Utility Functions

• Specify the labels using a label-name- (tgapi-util-get-cell-zone-id-
list (for example '(label1 la- list-with-labels "cell-zone-
bel2)). name-pattern* '(label-name-
list))
Edge Returns the list of edge zones (by ID) (tgapi-util-get-edge-zone-id-
zones containing the labels specified. list-with-labels '(edge-zone-
name-list) '(label-name-list))
• Specify the face zones using an edge-
(tgapi-util-get-edge-zone-id-
list-with-labels '(edge-zone-
tern*.
(tgapi-util-get-edge-zone-id-
• Specify the labels using a label-name- list-with-labels "edge-zone-
list (for example '(label1 la- name-pattern* '(label-name-
bel2)). list))
Remove From Removes the specified labels from the face (tgapi-util-remove-labels-on-
labels face zones. face-zones '(face-zone-name-
from zones list) '(label-name-list))
zones • Specify the face zones using a face-
(tgapi-util-remove-labels-on-
zone-name-list, face-zone-ID-
face-zones '(face-zone-ID-list)
'(label-name-list))
tern*.
• Specify the labels using a label-name- face-zones "face-zone-name-pat-
list (for example '(label1 la- tern*" '(label-name-list))
bel2)).
From Removes the specified labels from the cell (tgapi-util-remove-labels-on-

cell zones. cell-zones '(cell-zone-name-
zones list) '(label-name-list))
• Specify the cell zones using a cell-
cell-zones '(cell-zone-ID-list)
'(label-name-list))
tern*.
• Specify the labels using a label-name- cell-zones "cell-zone-name-pat-
bel2)).
From Removes the specified labels from the edge (tgapi-util-remove-labels-on-

edge zones. edge-zones '(edge-zone-name-
zones list) '(label-name-list))
• Specify the edge zones using an edge-
edge-zones '(edge-zone-ID-list)
'(label-name-list))
tern*.
• Specify the labels using a label-name- edge-zones "edge-zone-name-pat-
bel2)).
A.2.1. Examples
Consider a model with face zones part1, part2, part3, inlet1, inlet2, and outlet.
• Add labels on the specified face zones.
(tgapi-util-add-labels-on-face-zones '(inlet1 inlet2) '(inlet))
(tgapi-util-add-labels-on-face-zones "part*" '(wall solid))
• Return the list of labels on the specified face zone.
(tgapi-util-get-labels-on-face-zones '(12 34))
Returns list of labels: (inlet)
(tgapi-util-get-labels-on-face-zones "part*")
Returns list of labels: (wall solid)
• Remove labels from the specified face zones.
(tgapi-util-remove-labels-on-face-zones "part*" '(solid))
• Return the list of face zones (by ID) containing the labels specified.
(tgapi-util-get-face-zone-id-list-with-labels "inlet*" '(inlet))
Returns face zone ID list: (12 34)
A.3. Report Utility Functions

The following functions are available for reporting mesh quality, statistics, face/cell distribution:

Report Mesh Types Return zone type as integer (tgapi-util-get-zone-type
zone-id)
(tgapi-util-get-zone-type
zone-name)
Return cell zone shape as symbol (tgapi-util-get-cell-zone-
shape zone-id)
Report Mesh Return count of entities for face zones (tgapi-util-get-face-zone-
Statistics count '(zone-id-list))
count '(zone-name-list))
count "zone-name-pattern*")
Return count of entities for cell zones (tgapi-util-get-cell-zone-
count '(zone-id-list))
Report Utility Functions

count '(zone-name-list))
count "zone-name-pattern*")
Returns the node count for the specified (tgapi-util-get-face-zone-
face zone. node-count 'zone-id)
node-count 'zone-name)
node-count "zone-name")
Return face zone area for the specified (tgapi-util-get-face-zone-
zones area '(zone-id-list))
area '(zone-name-list))
area "zone-name-pattern*")
Return cell zone volume for the specified (tgapi-util-get-cell-zone-
zones volume '(zone-id-list))
volume '(zone-name-list))
volume "zone-name-pattern*")
Report Mesh Report the face mesh distribution based (tgapi-util-get-face-mesh-
Distribution on the specified measure, parti- distribution '(face-zone-
tions, and range (such as (0.9 1)). list) "measure" partitions
'(range))
Specify the "measure" as one of
(tgapi-util-get-face-mesh-
the following:
distribution "face-zone-name-
• "Skewness" pattern*" "measure" parti-
tions '(range))
• "Equiangle Skewness"
• "Size Change"
• "Edge Ratio"
• "Size"
• "Aspect Ratio"
• "Squish"
• "Warp"
• "Dihedral Angle"
• "ICEMCFD Quality"

• "Ortho Skew"
• "FLUENT Aspect Ratio"
• "Inverse Orthogonal Qual-

ity"
Report the cell mesh distribution based (tgapi-util-get-cell-mesh-

on the specified measure, parti- distribution '(cell-zone-
tions, and range (such as (0.9 1)). list) "measure" partitions
'(range))
(tgapi-util-get-cell-mesh-
the following:
distribution "cell-zone-name-
• "Skewness" pattern*" "measure" parti-
tions '(range))
• "Size Change"
• "Edge Ratio"
• "Size"
• "Aspect Ratio"
• "Squish"
• "Warp"
• "Ortho Skew"

ity"
Report Quality/Size Report the worst quality face and face (tgapi-util-get-face-quality-
Limits quality limits (minimum, maximum, limits '(face-zone-list)
average quality) for the list of zones "measure")
based on the measure specified. You (tgapi-util-get-face-quality-
can also report face size limits. limits "face-zone-name-pat-
tern*" "measure")
the following:
• "Skewness"

• "Size Change"
• "Edge Ratio"
• "Size"
• "Aspect Ratio"
• "Squish"
• "Warp"
• "Ortho Skew"

ity"
Report the number of cells and the cell (tgapi-util-get-cell-quality-

quality limits (minimum, maximum, limits '(cell-zone-list)
average quality) for the list of zones "measure")
based on the measure specified. You (tgapi-util-get-cell-quality-
can also report the cell size limits. limits "cell-zone-name-pat-
tern*" "measure")
the following:
• "Skewness"
• "Size Change"
• "Edge Ratio"
• "Size"
• "Aspect Ratio"
• "Squish"
• "Warp"
• "Ortho Skew"


ity"
Report the worst quality cell (ID and (tgapi-util-print-worst-qual-

location) for the cell zones based on the ity-cell '(cell-zone-list)
measure specified. "measure")
(tgapi-util-print-worst-qual-
ity-cell "cell-zone-name-pat-
the following:
tern*" "measure")
• "Skewness"
• "Size Change"
• "Edge Ratio"
• "Size"
• "Aspect Ratio"
• "Squish"
• "Warp"
• "Ortho Skew"

ity"
Report the edge size limits for the list of (tgapi-util-get-edge-size-

face zones limits '(face-zone-list))
(tgapi-util-get-edge-size-
limits "face-zone-name-pat-
tern*")
Report count Returns the count of free faces for the (tgapi-util-get-free-faces-
face zones specified count '(face-zone-name-list))
(tgapi-util-get-free-faces-
count '(face-zone-id-list))
(tgapi-util-get-free-faces-
count "face-zone-name-pat-
tern*")

Returns the count of multi-connected (tgapi-util-get-multi-faces-
faces for the face zones specified count '(face-zone-name-list))
(tgapi-util-get-multi-faces-
count '(face-zone-id-list))
(tgapi-util-get-multi-faces-
count "face-zone-name-pat-
tern*")
Returns the count of marked faces for (tgapi-util-count-marked-
the face zones specified faces '(face-zone-name-list))
(tgapi-util-count-marked-
faces '(face-zone-id-list))
(tgapi-util-count-marked-
faces "face-zone-name-pat-
tern*")
Print summary Print the diagnostics summary for a list (tgapi-util-print-dia-
of objects gnostics-summary '(object-
name-list))
Mesh check Reports the selected mesh check (tgapi-util-mesh-check "type-
statistics for the zones specified. name" '(edge-zone-list)
'(face-zone-list) '(cell-
• Specify the "type-name" as one of zone-list))
the following:
(tgapi-util-mesh-check "type-
– "bounding-box-statistics" name" "edge-zone-name-pat-
tern*" '(face-zone-list)
– "volume-statistics" '(cell-zone-list))
– "face-area-statistics" name" '(edge-zone-list)
"face-zone-name-pattern*"
– "nodes-per-edge"
'(cell-zone-list))
– "nodes-per-face" (tgapi-util-mesh-check "type-
name" "edge-zone-name-pat-
– "nodes-per-cell" tern*" "face-zone-name-pat-
tern*" '(cell-zone-list))
– "faces-or-neighbors-per-
cell" (tgapi-util-mesh-check "type-
name" '(edge-zone-list)
– "cell-faces-or-neighbors" '(face-zone-list) "cell-zone-
name-pattern*")
– "isolated-cells"
– "face-handedness" name" "edge-zone-name-pat-
tern*" "face-zone-name-pat-
– "periodic-face-pairs" tern*" "cell-zone-name-pat-
tern*")
– "face-children"
– "zone-boundary-conditions"

– "invalid-node-coordinates"
– "poly-cells"
– "parallel-invalid-zones"
– "parallel-invalid-neighbor-
hood"
– "parallel-invalid-inter-
faces"
Refer to Checking the Mesh in the

Fluent User's Guide for
descriptions of the individual
mesh checks.
• Specify the zones to be checked.
Specify the edge zones (edge-

zone-list or edge-zone-
name-pattern*), face zones
(face-zone-list or face-
zone-name-pattern*), and
cell zones (cell-zone-list or
cell-zone-name-pattern*).
A.4. Diagnostic Based Marking Utility Functions

The following functions are available for identifying faces/zones based on diagnostic criteria such as
face connectivity and quality:

Mark free faces on the face zones specified (tgapi-util-mark-free-faces '(zone-
id-list))
(tgapi-util-mark-free-faces '(zone-
name-list))
(tgapi-util-mark-free-faces "zone-
name-pattern*")
Mark multi-connected faces on the face zones (tgapi-util-mark-multi-faces '(zone-
specified based on fringe length (n) id-list) n)
(tgapi-util-mark-multi-faces '(zone-
name-list) n)
(tgapi-util-mark-multi-faces "zone-
name-pattern*" n)
Diagnostic Based Marking Utility Functions

Mark self-intersecting faces on the face zones (tgapi-util-mark-self-intersecting-
specified. Specify whether to mark folded faces or faces '(zone-id-list) mark-folded?)
not (mark-folded? set to #t or #f). (tgapi-util-mark-self-intersecting-
faces '(zone-name-list) mark-folded?)
(tgapi-util-mark-self-intersecting-
faces "zone-name-pattern*" mark-fol-
ded?)
Mark faces in self-proximity on the face zones (tgapi-util-mark-faces-in-self-prox-
specified. Specify whether to use relative tolerance imity '(zone-id-list) relative-toler-
(relative-tolerance? set to #t or #f), tol- ance? tolerance angle ignore-orient-
erance value, the angle, and whether to ignore ation?)
orientation (ignore-orientation? set to #t (tgapi-util-mark-faces-in-self-prox-
or #f). imity '(zone-name-list) relative-
tolerance? tolerance angle ignore-
orientation?)
(tgapi-util-mark-faces-in-self-prox-
imity "zone-name-pattern*" relative-
tolerance? tolerance angle ignore-
orientation?)
Mark duplicate faces on the face zones specified (tgapi-util-mark-duplicate-faces
'(zone-id-list))
(tgapi-util-mark-duplicate-faces
'(zone-name-list))
(tgapi-util-mark-duplicate-faces
Mark invalid normal locations on the face zones (tgapi-util-mark-invalid-normals
specified '(zone-id-list))
(tgapi-util-mark-invalid-normals
'(zone-name-list))
(tgapi-util-mark-invalid-normals
Mark point contact locations on the face zones (tgapi-util-mark-point-contacts
specified '(zone-id-list))
(tgapi-util-mark-point-contacts
'(zone-name-list))
(tgapi-util-mark-point-contacts
Mark island faces on the face zones specified, based (tgapi-util-mark-island-faces '(zone-
on the island face count (n) id-list) n)
(tgapi-util-mark-island-faces '(zone-
name-list) n)
(tgapi-util-mark-island-faces "zone-
name-pattern*" n)

Mark spikes on the face zones specified, based on (tgapi-util-mark-spikes '(zone-id-
the spike angle (spike-angle) list) spike-angle)
(tgapi-util-mark-spikes '(zone-name-
list) spike-angle)
(tgapi-util-mark-spikes "zone-name-
pattern*" spike-angle)
Mark steps on the face zones specified, based on (tgapi-util-mark-steps '(zone-id-
the step angle (step-angle) and step width list) step-angle step-width)
(step-width) (tgapi-util-mark-steps '(zone-name-
list) step-angle step-width)
(tgapi-util-mark-steps "zone-name-
pattern*" step-angle step-width)
Mark sliver faces on the face zones specified, based (tgapi-util-mark-sliver-faces '(zone-
on the maximum height (max-height) and id-list) max-height skew-limit)
skewness limit (skew-limit) (tgapi-util-mark-sliver-faces '(zone-
name-list) max-height skew-limit)
(tgapi-util-mark-sliver-faces "zone-
name-pattern*" max-height skew-limit)
Mark bad quality faces on the boundary face zones (tgapi-util-mark-bad-quality-faces
specified, based on the quality limit (quality- '(zone-id-list) quality-limit nrings)
limit) and number of rings (nrings). (tgapi-util-mark-bad-quality-faces
'(zone-name-list) quality-limit
nrings)
(tgapi-util-mark-bad-quality-faces
"zone-name-pattern*" quality-limit
nrings)
Mark faces based on the quality-measure and (tgapi-util-mark-faces-by-quality
quality-limit specified. Specify whether to '(zone-id-list) quality-measure
append the faces to those previously marked or quality-limit append-marking?)
clear previously marked faces (append-marking? (tgapi-util-mark-faces-by-quality
set to #t or #f) '(zone-name-list) quality-measure
quality-limit append-marking?)
(tgapi-util-mark-faces-by-quality
"zone-name-pattern*" quality-measure
quality-limit append-marking?)
Mark face strips based on the strip-type, (tgapi-util-mark-face-strips-by-
strip-height, quality-measure, quality- height-and-quality '(zone-id-list)
limit, and feature-angle specified. Possible strip-type strip-height quality-
values for strip-type are: measure quality-limit feature-angle)
(tgapi-util-mark-face-strips-by-
• 1: boundary-boundary strip. Multi-connected face
height-and-quality '(zone-name-list)
edges are also considered as boundary here.
strip-type strip-height quality-
• 2: feature-feature strip between angle based measure quality-limit feature-angle)
features. Feature edges, multi-connected edges,
Mesh Setup Utility Functions

and free edges are angle based features. Boundary (tgapi-util-mark-face-strips-by-
edges will be considered features if there is an height-and-quality "zone-name-pat-
angle. tern*" strip-type strip-height qual-
ity-measure quality-limit feature-
• 3: all-all strip between all boundaries and features. angle)
• 4: pure feature-feature strip. Only pure features,

boundary edges and multi edges will not be
considered as pure feature edges even if there is
an angle based feature.
The recommended value is 2.

Mark all faces at nodes based on deviation from (tgapi-util-mark-faces-deviating-
the size field. from-size-field '(zone-id-list) min-
size-factor max-size-factor "sf-type-
• Specify the zones using zone-id-list, zone- to-compare")
name-list, or zone-name-pattern*.
(tgapi-util-mark-faces-deviating-
• Specify the min-size-factor and max-size- from-size-field '(zone-name-list)
factor. min-size-factor max-size-factor "sf-
type-to-compare")
• Specify the size field type to be used to get size (tgapi-util-mark-faces-deviating-
at node. Set "sf-type-to-compare" to from-size-field "zone-name-pattern*"
"volumetric" or "geodesic". min-size-factor max-size-factor "sf-
type-to-compare")
Faces will be marked if the minimum edge length
at the node is less than min-size-
factor×size-at-node or the maximum edge
length is greater than max-size-factor×size-
at-node.
Mark all faces with node degree above the specified (tgapi-util-mark-faces-using-node-
threshold. Node degree is defined as the number degree '(zone-id-list) node-degree-
of edges connected to the node. threshold)
(tgapi-util-mark-faces-using-node-
• Specify the face zones using zone-id-list,
degree '(zone-name-list) node-degree-
zone-name-list, or zone-name-pattern*.
threshold)
• Specify the node-degree-threshold. (tgapi-util-mark-faces-using-node-
degree "zone-name-pattern*" node-de-
gree-threshold)
A.5. Mesh Setup Utility Functions

The following functions are available for mesh setup:

Return a suitable average point based on the zones (get-average-bounding-box-center
specified '(face-zone-ID-list))

Return the bounding box extents for the list of (tgapi-util-get-bounding-box-of-zone-
zones. list '(zone-id-list))
Enables you to unpreserve some/all preserved cell (tgapi-util-un-preserve-cell-zones
zones during the meshing process. '(cell-zone-list))
(tgapi-util-un-preserve-cell-zones
"cell-zone-name-pattern*")
Create bodies of influence and if required body of (tgapi-util-create-boi-and-size-
influence size functions from the mesh refinement functions-from-refinement-regions
regions. Specify the refinement region type (set "region-type" "boi-prefix-string"
"region-type" to "tet" or "hexcore"). create-size-function?)
Specify the prefix for the BOI zones ("boi-pre-
fix-string"), and choose whether to create the
size functions (set create-size-function? to
#t or #f).
Enables you to scale the face zones around a pivot (tgapi-util-scale-face-zones-around-
point or the bounding box center. Specify the face pivot '(face-zone-list) '(scale)
zones, the scale factors in the X, Y, Z directions '(pivot) use-bbox-center?)
(scale), the pivot point (pivot), and choose (tgapi-util-scale-face-zones-around-
whether to use the bounding box center (use- pivot "face-zone-name-pattern*"
bbox-center? set to #t or #f). '(scale) '(pivot) use-bbox-center?)
Enables you to scale the cell zones around a pivot (tgapi-util-scale-cell-zones-around-
point or the bounding box center. Specify the cell pivot '(cell-zone-list) '(scale)
zones, the scale factors in the X, Y, Z directions '(pivot) use-bbox-center?)
(scale), the pivot point (pivot), and choose (tgapi-util-scale-cell-zones-around-
whether to use the bounding box center (use- pivot "cell-zone-name-pattern*"
bbox-center? set to #t or #f). '(scale) '(pivot) use-bbox-center?)
Return the face zones and their orientation for the (tgapi-util-dump-face-zone-orienta-
mesh file specified tion-in-region "filename")
Returns a sorted list of volumetric regions by (tgapi-util-sort-regions-by-volume
volume for the object specified. Specify the order "object-name" "order")
(ascending or descending).
Return the region volume for the specified region (tgapi-util-get-region-volume 'ob-
of an object ject-name 'region-name)
(tgapi-util-get-region-volume "ob-
ject-name" "region-name")
Set the quality measure. (tgapi-util-set-quality-measure
"measure")
Specify the "measure" as one of the
following:
• "Skewness"
• "Size Change"
• "Edge Ratio"
Mesh Operation Utility Functions

• "Size"
• "Aspect Ratio"
• "Squish"
• "Warp"
• "Ortho Skew"
• "Inverse Orthogonal Quality"
Set object cell zone type (tgapi-util-set-object-cell-zone-type

'object 'cell-zone-type)
(tgapi-util-set-object-cell-zone-type
"object" 'cell-zone-type)
Set the number of compute threads to use for (tgapi-util-set-number-of-parallel-
algorithms like mesh check and quality compute-threads nthreads)
computation. You can use a variable number of
compute threads for these algorithms depending
on the current machine loads. The number of
compute threads is between 2 and the value
(maximum-cores-available - 1).
A.6. Mesh Operation Utility Functions

Rename zones Renames an existing face zone (tgapi-util-rename-face-zone
"zone-name" "new-name")
(tgapi-util-rename-face-zone
'zone-id "new-name")
Renames an existing edge zone (tgapi-util-rename-edge-zone
"zone-name" "new-name")
(tgapi-util-rename-edge-zone
'zone-id "new-name")
Replace the face zone suffix to rename (tgapi-util-replace-face-
face zones. Specify whether to merge zone-suffix '(face-zone-list)

the face zones being renamed (set "separator" "replace-with"
merge? to #t or #f). merge?)
Note:
If an empty string is
specified for the separ-
ator (" "), the string
specified for replace-
with will be appended
to the face zone names.
Replace the cell zone suffix to rename (tgapi-util-replace-cell-

cell zones. Specify whether to merge the zone-suffix '(cell-zone-list)
cell zones being renamed (set merge? "old-suffix" "new-suffix"
to #t or #f) merge?)
Replace the edge zone suffix to rename (tgapi-util-replace-edge-
edge zones. Specify whether to merge zone-suffix '(edge-zone-list)
the edge zones being renamed (set "old-suffix" "new-suffix"
merge? to #t or #f) merge?)
Removes the ID suffix from face zone (tgapi-util-remove-id-suffix-
names from-face-zones)
Clean up face zone names by removing (tgapi-util-clean-face-zone-
IDs wherever possible names)
Remove the zone ID (:id) from zone ID (tgapi-util-remove-ids-from-
list. zone-names '(zone-id-list))
Change zone ID Renumber zone IDs starting from the (tgapi-util-renumber-zone-ids
number specified (start-number). '(zone-id-list) start-number)
Rename objects Renames the object (tgapi-util-rename-object
"old-object-name" "new-ob-
ject-name")
Rename objects by replacing the object (tgapi-util-replace-object-
suffix with a new suffix suffix '(object-name) "separ-
ator" "new-suffix")
Rename labels Renames the face zone label (tgapi-util-rename-label "ob-
ject-name" "old-label-name"
"new-label-name")
Rename labels by replacing the label (tgapi-util-replace-label-
suffix with a new suffix suffix '(object-list) "separ-
ator" "new-suffix")
Copy labels Copy labels from one face zone to (tgapi-util-copy-labels from-
another. Specify either face zone names face-zone to-face-zone)
or IDs
Merge zones Merges the specified face zones. Specify (tgapi-util-merge-face-zones
a list of zone IDs or name pattern. '(zone-id-list))
Mesh Operation Utility Functions

(tgapi-util-merge-face-zones
Merges face zones of a given type based (tgapi-util-merge-face-zone-
on name pattern of-type 'zone-type "zone-
name-pattern*")
Merges face zones containing the (tgapi-util-merge-face-zones-
specified prefix with-same-prefix "prefix")
Merges the specified cell zones. Specify (tgapi-util-merge-cell-zones
a list of cell zones or name pattern. '(cell-zone-list))
(tgapi-util-merge-cell-zones
"cell-zone-name-pattern*")
Merge cell zones containing the specified (tgapi-util-merge-cell-zones-
prefix with-same-prefix "prefix")
Merge cell zones containing the specified (tgapi-util-merge-cell-zones-
suffix with-same-suffix "suffix")
Separate Separates cells that are connected to (tgapi-util-separate-cell-
specified face zones into another cell zone-layers-by-face-zone
zone. This separation method applies '(cell-zone-id) '(face-zone-
only to prism cells. Specify the number list) nlayers)
of layers of cells (nlayers) to be (tgapi-util-separate-cell-
separated. zone-layers-by-face-zone
'(cell-zone-id) "face-zone-
name-pattern*" nlayers)
(tgapi-util-separate-cell-
zone-layers-by-face-zone
"cell-zone-name" '(face-zone-
list) nlayers)
(tgapi-util-separate-cell-
zone-layers-by-face-zone
"cell-zone-name" "face-zone-
name-pattern*" nlayers)
Separate face zones based on the cell (tgapi-util-separate-face-
neighbors. zones-by-cell-neighbor
'(face-zone-list))
(tgapi-util-separate-face-
zones-by-cell-neighbor "face-
zone-name-pattern*")
Refine Refine marked faces (tgapi-util-refine-marked-
faces-in-zones '(face-zone-
list))
(tgapi-util-refine-marked-
faces-in-zones "face-zone-
name-pattern*")

Patch Fill holes associated with free edges for (tgapi-util-fill-holes-in-
the face zones specified, based on the face-zone-list '(face-zone-
number of free edges (max-hole- list) max-hole-edges)
edges) (tgapi-util-fill-holes-in-
face-zone-list "face-zone-
name-pattern*" max-hole-
edges)
Project Project a zone on the plane specified. (tgapi-util-project-zone-on-
Specify three points for defining the plane zone-id plane)
plane.
Delete Deletes all sub-domains (all domains (tgapi-util-delete-all-sub-
other than global) domains)
Delete marked faces (tgapi-util-delete-marked-
faces-in-zones '(face-zone-
list))
(tgapi-util-delete-marked-
faces-in-zones "face-zone-
name-pattern*")
Delete empty zones based on the zones (tgapi-util-delete-empty-
specified face-zones '(face-zone-list))
(tgapi-util-delete-empty-
face-zones "face-zone-name-
pattern*")
edge-zones '(edge-zone-list))
edge-zones "edge-zone-name-
pattern*")
cell-zones '(cell-zone-list))
cell-zones "cell-zone-name-
pattern*")
zones '(zone-list))
Validate mesh Report if the boundary face zone exists (tgapi-util-boundary-zone-ex-
ists? zone-id)
(tgapi-util-boundary-zone-ex-
ists? 'zone-name)
Report if the interior face zone exists (tgapi-util-interior-zone-ex-
ists? zone-id)
(tgapi-util-interior-zone-ex-
ists? 'zone-name)
Miscellaneous Functions

Report if the cell zone exists (tgapi-util-cell-zone-exists?
zone-id)
(tgapi-util-cell-zone-exists?
'zone-name)
Report if the volume mesh exists (tgapi-util-mesh-exists?)
A.7. Miscellaneous Functions

String operations Check if the string contains another (tgapi-util-string-contains?
string "string1*" "string2*")
Enables you to split a string by the (tgapi-util-string-split
specified character. "original-string" "split-
character")
Enables you to split a string by the (tgapi-util-string-split-
specified string. with-string "original-string"
"split-string")
Enables you to replace a part (old- (tgapi-util-string-replace
sub-string) of a target-string "target-string" "old-sub-
by the specified string (new-sub- string" "new-sub-string")
string).
For example: (tgapi-util-
string-replace "tst-
string" "tst" "test") will
return "test-string".
Folder/directory Returns the path for the working (tgapi-util-get-mesher-work-
Management directory ing-directory)
Sync the Cortex current working (tgapi-util-sync-directories
directory with the Fluent current working directory)
directory (directory)
File management Finds the file in the working directory (tgapi-util-find-file-with-
based on the filename and file- suffix "filename" "file-suf-
suffix specified. fix")
(tgapi-util-find-file-pat-
tern-with-suffix "filename"
"file-suffix")
Returns the last read file (tgapi-util-get-last-read-
file-name)
Returns the file suffix for the last read (tgapi-util-get-last-read-
file file-suffix)
Appendix B. Boundary Functions
The following boundary functions are available.
Note:

Improve surface Improve marked faces by splitting the (tgapi-boundary-split-marked-
mesh longer edge. faces '(face-zone-id-list)
longer-edge-split-ratio)
• Specify the face zones using a face-
(tgapi-boundary-split-marked-
zone-id-list, face-zone-name-
faces '(face-zone-name-list)
longer-edge-split-ratio)
tern*.
(tgapi-boundary-split-marked-
• Specify the longer-edge-split- faces "face-zone-name-pat-
ratio (length ratio for the split tern*" longer-edge-split-ra-
created by projecting the opposite tio)
node onto the longer edge). The valid
range is 0 to 0.5 and the
recommended value is 0.25.
Improve marked faces by collapsing face (tgapi-boundary-collapse-

edges. marked-faces '(face-zone-id-
list) preserve-boundary?
• Specify the face zones using a face- boundary-corner-angle max-
zone-id-list, face-zone-name- collapsible-edge-ratio)
(tgapi-boundary-collapse-
tern*.
marked-faces '(face-zone-
• Choose whether to preserve the name-list) preserve-boundary?
boundary by setting preserve- boundary-corner-angle max-
boundary? to #t or #f. collapsible-edge-ratio)
(tgapi-boundary-collapse-
– If preserve-boundary? is marked-faces "face-zone-name-
enabled (#t), specify the bound- pattern*" preserve-boundary?
ary-corner-angle to be used boundary-corner-angle max-
for marking fixed nodes on the collapsible-edge-ratio)
boundary. The recommended value
is 20 degrees.
• Set the max-collapsible-edge-

ratio depending on the improve
operation:
Boundary Functions

– To improve general quality, specify
a value between 0 to 0.5. A value
of 0.5 is recommended.
– To collapse sliver faces, specify a

value of 0.1.
Note:
A value of 0 will result

in all marked faces
being collapsed.
Tip:
Use this operation when

the mesh skewness is
greater than 0.7.
Also, it is recommended
to mark faces and
collapse faces by edge
ratio incrementally. For
example, first mark faces
with skewness greater
than 0.9 and then
collapse marked faces
using an edge ratio of
0.1. When the mesh
quality is improved, next
mark faces with
skewness greater than
0.8 and then collapse
marked faces using an
edge ratio of 0.2; and so
on.
Improve sliver faces by splitting and (tgapi-boundary-split-and-

collapsing edges. collapse-sliver-faces '(face-
zone-id-list) sliver-height
• Specify the face zones using a face- "sliver-quality-measure"
zone-id-list, face-zone-name- sliver-quality longer-edge-
list, or face-zone-name-pat- split-ratio preserve-bound-
tern*. ary? boundary-corner-angle)
• Specify the height threshold for sliver (tgapi-boundary-split-and-
face improvement. All faces with collapse-sliver-faces '(face-
sliver-height less than the zone-name-list) sliver-height
specified value will be marked for "sliver-quality-measure"
improvement. Sliver height is the sliver-quality longer-edge-
shortest height of the triangular face - split-ratio preserve-bound-
the distance between the location of ary? boundary-corner-angle)
the opposite node and its projection(tgapi-boundary-split-and-
point on the longer edge. collapse-sliver-faces "face-
zone-name-pattern*" sliver-
• Specify either "Skewness" or "As-
height "sliver-quality-meas-
pect Ratio" as the "sliver-
ure" sliver-quality longer-
quality-measure", and the
edge-split-ratio preserve-
sliver-quality threshold used for
boundary? boundary-corner-
marking.
angle)
• Specify the longer-edge-split-
ratio (length ratio for the split
created by projecting the opposite
node onto the longer edge). The valid
range is 0 to 0.5 and the
recommended value is 0.25.
• Choose whether to preserve the

boundary by setting preserve-
boundary? to #t or #f.
– If preserve-boundary? is
enabled (#t), specify the bound-
ary-corner-angle to be used
for marking fixed nodes on the
boundary. The recommended value
is 20 degrees.
Patch Create a planar surface to patch holes (tgapi-boundary-fill-planar-

associated with free faces for the face holes-using-free-faces
zones specified. The free faces should be '(face-zone-id-list) plane
continuous for the planar patch to be tolerance absolute-toler-
created. ance?)
(tgapi-boundary-fill-planar-
• Specify the face zones with free faces
using a face-zone-id-list, holes-using-free-faces
face-zone-name-list, or face- '(face-zone-name-list) plane
zone-name-pattern*. tolerance absolute-toler-
ance?)
• Specify three coplanar points to define (tgapi-boundary-fill-planar-
the plane (for example, (list '(- holes-using-free-faces "face-
10 5 5) '(0 5 5) '(0 -5 zone-name-pattern*" plane
5))). tolerance absolute-toler-
ance?)
• Specify the tolerance value, and
choose whether to use an absolute
tolerance (set absolute-toler-
ance? to #t or #f). Nodes within the
Boundary Functions

tolerance from the plane will be used
to create the planar surface.
Note:
The patch surface is not

connected to the original
face zones.
Create a planar surface to patch holes (tgapi-boundary-fill-planar-

associated with free faces for the object holes-using-free-faces-in-ob-
and face zone labels specified. The free ject 'object '(face-zone-la-
faces should be continuous for the bel-list) plane tolerance
planar patch to be created. absolute-tolerance? "new-la-
bel-name")
• Specify the object and the face zone
labels with free faces using a face- (tgapi-boundary-fill-planar-
zone-label-list or face-zone- holes-using-free-faces-in-ob-
label-name-pattern*. ject 'object "face-zone-la-
bel-name-pattern*" plane
• Specify three coplanar points to define tolerance absolute-tolerance?
the plane (for example, (list '(- "new-label-name")
10 5 5) '(0 5 5) '(0 -5 (tgapi-boundary-fill-planar-
5))). holes-using-free-faces-in-ob-
ject "object" '(face-zone-
• Specify the tolerance value, and label-list) plane tolerance
choose whether to use an absolute absolute-tolerance? "new-la-
tolerance (set absolute-toler- bel-name")
tolerance from the plane will be used (tgapi-boundary-fill-planar-
to create the planar surface. holes-using-free-faces-in-ob-
ject "object" "face-zone-la-
• Specify the new-label-name for the bel-name-pattern*" plane
planar surface created. The patch tolerance absolute-tolerance?
surface is included in the object and a "new-label-name")
new face zone label is created.
Create a planar surface to patch holes (tgapi-boundary-create-

using the free face edges for the edge planar-surface-using-edges
zones specified. The edge zone should '(edge-zone-id-list) plane
be continuous and free from tolerance absolute-toler-
intersections. ance?)
(tgapi-boundary-create-
• Specify the edge zones using an
edge-zone-id-list, edge-zone- planar-surface-using-edges
name-list, or edge-zone-name- '(edge-zone-name-list) plane
pattern*. tolerance absolute-toler-
ance?)
• Specify three coplanar points to define (tgapi-boundary-create-
the plane (for example, (list '(- planar-surface-using-edges
10 5 5) '(0 5 5) '(0 -5 "edge-zone-name-pattern*"
5))). plane tolerance absolute-
tolerance?)
• Specify the tolerance value, and
choose whether to use an absolute
tolerance (set absolute-toler-
tolerance from the plane will be used
to create the planar surface.
Note:
The patch surface is not

connected to the original
face zones.
Remesh Remesh the marked faces. (tgapi-boundary-remesh-

marked-faces '(face-zone-id-
• Specify the face zones using a face- list) n-rings preserve-
zone-id-list, face-zone-name- shared-zone-boundary? fea-
list, or face-zone-name-pat- ture-min-angle feature-max-
tern*. angle corner-angle "sizing-
option" constant-size min-
• Specify the number of rings (n- size max-size growth-rate)
rings).
(tgapi-boundary-remesh-
• Choose whether to preserve the shared marked-faces '(face-zone-
zone boundary by setting preserve- name-list) n-rings preserve-
shared-zone-boundary? to #t or shared-zone-boundary? fea-
#f (recommended). ture-min-angle feature-max-
angle corner-angle "sizing-
• Specify the feature-min-angle option" constant-size min-
and feature-max-angle. The size max-size growth-rate)
feature-min-angle and fea- (tgapi-boundary-remesh-
ture-max-angle are the limits for marked-faces "face-zone-name-
the feature angle. Recommended pattern*" n-rings preserve-
values are 40 and 180, respectively. If shared-zone-boundary? fea-
the mesh has false features like folds ture-min-angle feature-max-
and overlaps, the feature-max-
angle corner-angle "sizing-
angle can be set to 155.
option" constant-size min-
• Specify the corner-angle. The size max-size growth-rate)
corner-angle is the minimum angle
between feature edges that will be
preserved during remeshing. The
recommended value is 20.
• Select a "sizing-option" using

"geometric", "constant",
"geodesic" or "volumetric".
Boundary Functions

• Specify values for constant-size
(used when "sizing-option" is set
to "constant"), min-size, max-
size, and growth-rate (these are
used when "sizing-option" is set
to "geometric" or "geodesic").
Note:
All four values must

be provided regardless
of the selected "siz-
ing-option".
A value of -1 can be
used for the
parameters that are
not required for a
particular sizing
option.
Remesh face zones by separating them (tgapi-boundary-remesh-face-

internally into patches and later merging zones '(face-zone-list)
them. The patches which fail to remesh '(edge-zone-list) replace-
using the advancing front (surfer) face-zones? feature-min-angle
algorithm will be remeshed using explicit feature-max-angle corner-
remeshing (split, improve, and coarsen). angle "sizing-option" con-
You can specify the number of attempts stant-size min-size max-size
for the advancing front algorithm and growth-rate n-retries-on-
also use explicit remeshing for the failed improve-failed? front-
patches, if required. intersection-tolerance)
• Specify the face zones and edge zones (tgapi-boundary-remesh-face-

using a face/edge zone list or by zones '(face-zone-list)
face/edge zone name pattern. "edge-zone-name-pattern*" re-
place-face-zones? feature-
• Choose whether to replace the original min-angle feature-max-angle
zones with the remeshed zones by corner-angle "sizing-option"
setting replace-face-zones? to constant-size min-size max-
#t or #f (recommended). size growth-rate n-retries-
on-failed improve-failed?
• Specify the feature-min-angle front-intersection-tolerance)
and feature-max-angle. The
(tgapi-boundary-remesh-face-
feature-min-angle and fea-
ture-max-angle limits are used to
tern*" '(edge-zone-list) re-
retain angle-based features.
place-face-zones? feature-
Recommended values are 40 and 180,
min-angle feature-max-angle
respectively. If the mesh has false
corner-angle "sizing-option"
features like folds and overlaps, the
constant-size min-size max-
feature-max-angle can be set to size growth-rate n-retries-
155. on-failed improve-failed?
front-intersection-tolerance)
• Specify the corner-angle. The
(tgapi-boundary-remesh-face-
tern*" "edge-zone-name-pat-
preserved for corner nodes during
tern*" replace-face-zones?
remeshing. The recommended value
feature-min-angle feature-
is 20.
max-angle corner-angle "siz-
• Select a "sizing-option" using ing-option" constant-size
"constant", "geodesic" or min-size max-size growth-rate
"volumetric". n-retries-on-failed improve-
failed? front-intersection-
tolerance)
Note:
The "geometric"
option is not
supported.
• Specify values for constant-size

(used when "sizing-option" is set
to "constant"), min-size, max-
size, and growth-rate (these are
used when "sizing-option" is set
to "geodesic"). These values are not
used when the "sizing-option"
is set to "volumetric".
Note:
All four values must

be provided regardless
of the selected "siz-
ing-option".
A value of -1 can be
used for the
parameters that are
not required for a
particular sizing
option.
• Specify the number of attempts to

improve the failed patches using
explicit remeshing (n-retries-on-
failed) and whether to further
Boundary Functions

explicit remeshing improve-
failed? set to #t or #f.
• Specify the front-intersection-

tolerance for checking intersections.
The value specified should be in the
range 0 to 1. The recommended value
is 0.0, which can be increased if the
remeshed patch shows intersections.
Remesh object face zone labels by (tgapi-boundary-remesh-ob-

separating them internally into patches ject-labels 'object-name
and later merging them. The patches '(face-zone-label-list)
which fail to remesh using the surfer '(edge-zone-list) feature-
(advancing front) algorithm, will be min-angle feature-max-angle
remeshed using explicit remeshing (split, corner-angle "sizing-option"
improve, and coarsen). You can specify constant-size min-size max-
the number of attempts for the surfer size growth-rate n-retries-
algorithm and also use explicit on-failed improve-failed?
remeshing for the patches, if required. front-intersection-tolerance)
• Specify the object, face zone labels (tgapi-boundary-remesh-ob-

(face-zone-label-list or face- ject-labels 'object-name
zone-label-pattern*), and edge '(face-zone-label-list)
zones (edge-zone-list or edge- "edge-zone-name-pattern*"
zone-name-pattern*). feature-min-angle feature-
max-angle corner-angle "siz-
• Specify the feature-min-angle ing-option" constant-size
and feature-max-angle. The min-size max-size growth-rate
feature-min-angle and fea- n-retries-on-failed improve-
ture-max-angle limits are used to failed? front-intersection-
retain angle-based features. tolerance)
Recommended values are 40 and 180, (tgapi-boundary-remesh-ob-
respectively. If the mesh has falseject-labels 'object-name
features like folds and overlaps, the
"face-zone-label-pattern*"
feature-max-angle can be set to '(edge-zone-list) feature-
155. min-angle feature-max-angle
• Specify the corner-angle. The constant-size min-size max-
corner-angle is the minimum angle size growth-rate n-retries-
between feature edges that will be on-failed improve-failed?
front-intersection-tolerance)
remeshing. The recommended value
is 20. (tgapi-boundary-remesh-ob-
ject-labels "object-name"
• Select a "sizing-option" using '(face-zone-label-list)
"constant", "geodesic" or '(edge-zone-list) feature-
"volumetric". min-angle feature-max-angle
Note: constant-size min-size max-
size growth-rate n-retries-
The "geometric" on-failed improve-failed?
option is not front-intersection-tolerance)
supported. (tgapi-boundary-remesh-ob-
ject-labels "object-name"
'(face-zone-label-list)
• Specify values for constant-size "edge-zone-name-pattern*"
(used when "sizing-option" is set feature-min-angle feature-
to "constant"), min-size, max- max-angle corner-angle "siz-
size, and growth-rate (these are ing-option" constant-size
used when "sizing-option" is set min-size max-size growth-rate
to "geodesic"). These values are not n-retries-on-failed improve-
used when the "sizing-option" failed? front-intersection-
is set to "volumetric". tolerance)
(tgapi-boundary-remesh-ob-
Note: ject-labels "object-name"
"face-zone-label-pattern*"
All four values must '(edge-zone-list) feature-
be provided regardless min-angle feature-max-angle
of the selected "siz- corner-angle "sizing-option"
ing-option". constant-size min-size max-
size growth-rate n-retries-
A value of -1 can be on-failed improve-failed?
used for the front-intersection-tolerance)
parameters that are
not required for a
particular sizing
option.
• Specify the number of attempts to

explicit remeshing (n-retries-on-
failed) and whether to further
explicit remeshing improve-
failed? set to #t or #f.

Boundary Functions
B.1. Examples
To improve mesh quality on all face zones, use marking utilities with functions for improving the surface
mesh and remeshing.
• Mark faces based on quality:
(tgapi-util-mark-faces-by-quality "*" "Skewness" 0.6 #f)
• Improve the marked faces by splitting the longer edge.
(tgapi-boundary-split-marked-faces "*" 0.25)
• Improve sliver faces
(tgapi-boundary-split-and-collapse-sliver-faces "*" 0.01 "Skewness" 0.95

0.25 #t 20)
• Mark face strips between all boundaries based on strip height and quality.
(tgapi-util-mark-face-strips-by-height-and-quality "*" 3 0.01 "Skewness"

0.9 40)
• Improve the marked faces by collapsing face edges.
(tgapi-boundary-collapse-marked-faces "*" #f 20 0.5)
• Remesh the marked faces based on the size field:
(tgapi-boundary-remesh-marked-faces "*" 3 #f 40 180 20 "geodesic" 0.05

0.05 2.5 1.6)
For a mesh object _fluid, remesh all face zones using different sizing options:
• Using geodesic sizing
(tgapi-boundary-remesh-face-zones (tgapi-util-get-face-zone-id-list-of-
object "_fluid") (tgapi-util-get-edge-zone-id-list-of-object "_fluid")
#t 40 155 20 "geodesic" -1 0.35 260 1.35 1 #t 0.3)
• Using volumetric sizing
#t 40 155 20 "volumetric" -1 -1 -1 -1 1 #t 0.0)
• Using constant sizing
Examples
#t 40 155 20 "constant" 2.0 -1 -1 -1 1 #t 0.0)
Note:
In these examples, a value of -1 has been used for the parameters that are not required for
a particular sizing option.
For a mesh object _fluid, remesh object face zone labels using different sizing options:
• Using geodesic sizing
(tgapi-boundary-remesh-object-labels "_fluid" "*" "*" 40 155 20

"geodesic" -1 0.5 5 1.2 0 #f 0.0)
• Using volumetric sizing
(tgapi-boundary-remesh-object-labels "_fluid" "*" "*" 40 155 20 "volu-

metric" -1 -1 -1 -1 1 #f 0.0)
• Using constant sizing
(tgapi-boundary-remesh-object-labels "_fluid" "*" "*" 40 155 20 "con-

stant" 2.0 -1 -1 -1 1 #f 0.0)
Note:
In these examples, a value of -1 has been used for the parameters that are not required for
a particular sizing option.
Patch holes associated with free faces.
• Create a planar surface to patch holes associated with free faces for the list of face zones.
(tgapi-boundary-fill-planar-holes-using-free-faces '(6 5 3 4) (list '(-

10 5 5) '(0 5 5) '(0 -5 5)) 0.001 #t)
• Create a planar surface to patch holes associated with free faces for the list of object face zone labels.
(tgapi-boundary-fill-planar-holes-using-free-faces-in-object "object"
"*" (list '(-10 5 5) '(0 5 5) '(0 -5 5)) 0.001 "symmetry" #t)
• Create a planar surface to patch holes using the free face edges for the edge zones specified.
(tgapi-boundary-create-planar-surface-using-edges "*" (list '(-10 5 5)

'(0 5 5) '(0 -5 5)) 0.001 #f)
Appendix C. Connect Functions
The following connect functions are available.
Note:

Connect overlapping face zone label pairs by joining (tgapi-connect-join-across-label-
zones across label pairs. pairs 'object-name '(label-pairs)
feature-angle tolerance absolute-
• Specify the mesh object-name. tolerance? separate-overlaps? "separ-
ate-method" remesh? "sizing-method"
• Specify a list of face zone label-pairs to be no-of-layers)
connected. For example, (label1 label2).
• Specify values for the parameters:
– feature-angle (default is 40)
– tolerance (default is 0.95)
– absolute-tolerance? Specify #t or #f
(default, for relative tolerance).
– separate-overlaps? Specify #t (default)

or #f to separate overlapping zones.
– "separate-method" Specify "keep-none"

or "keep-one" (recommended).
– remesh? Specify #t (default) or #f to remesh

after the connect operation.
– "sizing-method" Set to "geometric"

(default) or "size-field".
– no-of-layers Specify the number of rings

of faces to be remeshed around the
connections, default is 3.
Connect overlapping face zone label pairs by (tgapi-connect-intersect-across-la-

intersecting zones across label pairs. bel-pairs 'object-name '(label-pairs)
feature-angle tolerance absolute-
• Specify the mesh object-name. tolerance? separate-intersections?
remesh? "sizing-method" no-of-layers)
Connect Functions

• Specify a list of face zone label-pairs to be
– separate-intersections? Specify #t
(default) or #f to separate intersecting zones.



Connect overlapping face zone label pairs by (tgapi-connect-stitch-across-label-

stitching zones across label pairs. pairs 'object-name '(label-pairs)
"stitch-method" feature-angle toler-
• Specify the mesh object-name. ance absolute-tolerance? remesh?
"sizing-method" no-of-layers)
• Specify a list of face zone label-pairs to be
– "stitch-method" Specify "all-all"

(default), "free-free", or "free-non-
free".


Examples

C.1. Examples
For a mesh object _fluid with face zone labels part1, part2, and part3:
• Connect overlapping face zone label pairs by joining zones across label pairs.
(tgapi-connect-join-across-label-pairs '_fluid (list '(part1 part2)

'(part1 part3) '(part2 part3)) 40 0.95 #f #t "keep-one" #t "geometric"
3)
• Connect overlapping face zone label pairs by intersecting zones across label pairs.
(tgapi-connect-intersect-across-label-pairs '_fluid (list '(part1 part2)

'(part1 part3) '(part2 part3)) 40 0.95 #f #t #t "geometric" 3)
• Connect overlapping face zone label pairs by stitching zones across label pairs.
(tgapi-connect-stitch-across-label-pairs '_fluid (list '(part1 part2)

'(part1 part3) '(part2 part3)) "all-all" 40 0.95 #f #t "geometric" 3)
Appendix D. Size Field Functions
The size field defines the sizes in the volume. Having volumetric sizes could pose problems where sizes
are diffused across dead space, leading to unnecessary refinement. In addition to volumetric sizing, a
new type of size definition (geodesic) is introduced to define the sizes along a surface rather than the
volume. The geodesic sizing enables you to confine sizes to surfaces and avoid problems like dead
space refinement.
The following size field functions are available.
Note:

Initialize On face Initialize geodesic sizing on the specified (tgapi-size-field-initialize-
geodesic zones face zones. geodesic-on-face-zones
sizing '(face-zone-name-list) max-
• Specify the face zones using a face- size)
zone-id-list, face-zone-
(tgapi-size-field-initialize-
name-list, or face-zone-name-
geodesic-on-face-zones
pattern*.
'(face-zone-ID-list) max-
• Specify the max-size value. size)
max-size)
On Initialize geodesic sizing on the specified (tgapi-size-field-initialize-
object object face zone labels. geodesic-on-object-labels
face '(object-list) '(face-zone-
zone • Specify the object-list or ob- label-list) max-size)
labels ject-name-pattern* and the face
zone labels using a face-zone-la-
geodesic-on-object-labels
bel-list or face-zone-label-
'(object-list) "face-zone-
name-pattern*.
label-name-pattern*" max-
• Specify the max-size value. size)
"object-name-pattern*"
'(face-zone-label-list) max-
size)
Size Field Functions

"object-name-pattern*"
"face-zone-label-name-pat-
tern*" max-size)
On Initialize geodesic sizing on the face (tgapi-size-field-initialize-
object zones for the specified objects. geodesic-on-objects '(ob-
face ject-list) max-size)
zones • Specify the object-list or ob-
ject-name-pattern*.
geodesic-on-objects "object-
• Specify the max-size value. name-pattern*" max-size)
Compute Geodesic Computes geodesic sizes on face nodes (tgapi-size-field-compute-

size sizes based on the size controls specified. geodesic '(size-control-
field name-list))
(tgapi-size-field-compute-
geodesic '(size-control-
name-pattern*))
geodesic "size-control-name-
pattern*)
Volumetric Computes the volumetric size field (tgapi-size-field-compute-
sizes based on the size controls specified. volumetric '(size-control-
name-list))
volumetric '(size-control-
name-pattern*))
volumetric "size-control-
name-pattern*")
Geodesic Computes the geodesic blended size (tgapi-size-field-compute-
blended field as follows. geodesic-blended '(size-con-
size field trol-name-list))
• The volumetric size field is computed
based on all edge, face proximity and
geodesic-blended '(size-con-
BOI controls.
trol-name-pattern*))
• Geodesic sizes are computed based (tgapi-size-field-compute-
on the remaining size controls. geodesic-blended "size-con-
trol-name-pattern*")
• Updates geodesic sizes based on
volumetric sizes (the lower minimum
size (geodesic or volumetric) will be
used).
• Hard sizes are computed last.
Update On face Updates nodal (geodesic) sizes based (tgapi-size-field-update-

geodesic zones on the existing volumetric size field for geodesic-with-volumetric-on-
sizes the face zones specified. This requires
with the volumetric size field to be face-zones '(face-zone-id-
volumetric computed. list))
sizes (tgapi-size-field-update-
Specify the face zones using a
geodesic-with-volumetric-on-
face-zone-id-list, face-
face-zones '(face-zone-name-
zone-name-list, or face-
list))
zone-name-pattern*.
(tgapi-size-field-update-
Note:
face-zones "face-zone-name-
Geodesic sizes need to pattern*")
be initialized and
computed before
attempting an update.
On Updates nodal (geodesic) sizes based (tgapi-size-field-update-

object on the existing volumetric size field for geodesic-with-volumetric-on-
face the face zone labels specified. This object-labels 'object-name
zone requires the volumetric size field to be '(face-zone-label-list))
labels computed. (tgapi-size-field-update-
Specify the object-name and the
object-labels 'object-name
face zone labels using a face-
'(face-zone-label-name-pat-
zone-label-list or face-
tern*))
zone-label-name-pattern*.
Note:
object-labels 'object-name
Geodesic sizes need to "face-zone-label-name-pat-
be initialized and tern*")
computed before (tgapi-size-field-update-
attempting an update. geodesic-with-volumetric-on-
object-labels "object-name"
'(face-zone-label-name-pat-
tern*))
"face-zone-label-name-pat-
tern*")

On Updates nodal (geodesic) sizes based (tgapi-size-field-update-
object on the existing volumetric size field for geodesic-with-volumetric-on-
face the face zones of the objects specified. objects '(object-list))
zones This requires the volumetric size field (tgapi-size-field-update-
to be computed. geodesic-with-volumetric-on-
objects "object-name-pat-
Specify the object-list or ob-
tern*")
ject-name-pattern*.
Note:
Geodesic sizes need to

be initialized and
computed before
attempting an update.
Scale On Scales and limits geodesic sizes on the (tgapi-size-field-scale-

geodesic marked marked faces for the face zones geodesic-on-marked-faces
sizes faces specified. '(face-zone-id-list) scale-
factor min-size max-size)
(tgapi-size-field-scale-
geodesic-on-marked-faces
'(face-zone-name-list)
pattern*.
scale-factor min-size max-
• Specify the scale-factor. size)
• Specify the values for min-size and geodesic-on-marked-faces
max-size "face-zone-name-pattern*"
size)
On face Scales and limits geodesic sizes on the (tgapi-size-field-scale-
zones faces for the face zones specified. geodesic-on-face-zones
'(face-zone-id-list) scale-
• Specify the face zones using a face- factor min-size max-size)
pattern*.
'(face-zone-name-list)
• Specify the scale-factor. scale-factor min-size max-
size)
• Specify the values for min-size and (tgapi-size-field-scale-
max-size geodesic-on-face-zones
size)
On Scales and limits geodesic sizes on the
object faces for the face zone labels specified.
face 'object-name '(face-zone-la-
zone • Specify the object-name and the bel-list) scale-factor min-
labels face zone labels using a face-zone- size max-size)
label-list or face-zone-la-
bel-name-pattern*.
• Specify the scale-factor. 'object-name "face-zone-la-
bel-name-pattern*" scale-
• Specify the values for min-size and factor min-size max-size)
max-size (tgapi-size-field-scale-
"object-name" '(face-zone-
label-list) scale-factor
min-size max-size)
"object-name" "face-zone-la-
bel-name-pattern*" scale-
factor min-size max-size)
On Scales and limits geodesic sizes on the (tgapi-size-field-scale-
object object face zones specified. geodesic-on-objects '(ob-
face ject-list) '(face-zone-la-
zones • Specify the object-list or ob- bel-list) scale-factor min-
ject-name-pattern*. size max-size)
• Specify the scale-factor. (tgapi-size-field-scale-
• Specify the values for min-size and "object-name-pattern*"
max-size "face-zone-label-name-pat-
tern*" scale-factor min-size
max-size)
Filter On face Removes refined surface mesh clusters (tgapi-size-field-filter-
noise zones generated by geodesic sizing on the noise-geodesic '(face-zone-
specified face zones. id-list) growth-rate face-
count)
(tgapi-size-field-filter-
noise-geodesic '(face-zone-
name-list) growth-rate face-
pattern*.
count)
• Specify the growth-rate. It is (tgapi-size-field-filter-
recommended to use a growth rate noise-geodesic "face-zone-
value higher than the value used for name-pattern*" growth-rate
computing the geodesic sizes (for face-count)
example, 1.6).
• Specify the face-count threshold.

For face clusters whose count is less
than the specified threshold value, the

geodesic size values will be set to the
average of the values on the cluster
boundary.
Note:
Geodesic sizes need to

be initialized and
computed, but
undiffused for the face
zones specified.
Diffuse On face Diffuse geodesic sizing on the specified (tgapi-size-field-diffuse-

geodesic zones face zones. Diffusion can also happen geodesic-on-face-zones
sizing on face zones which are not specified, '(face-zone-name-list) min-
if they can be reached by node flood size max-size growth-rate
filling. diffuse-across-free-edge?
free-diffusion-range)
(tgapi-size-field-diffuse-
'(face-zone-id-list) min-
pattern*.
size max-size growth-rate
• Specify the minimum and maximum diffuse-across-free-edge?
size limits to apply for the node size free-diffusion-range)
(min-size, max-size. (tgapi-size-field-diffuse-
Important: "face-zone-name-pattern*"
min-size max-size growth-
The sizes will be rate diffuse-across-free-
bounded to the min- edge? free-diffusion-range)
size and max-size
specified. The final
minimum node size
will be the maximum
of (node-min-size,
min-size) and final
maximum node size
will be the minimum
of (node-max-size,
max-size).
It is recommended
that you specify the
global minimum size
required, as you
cannot revert to the
earlier minimum size
after size diffusion.
• Specify the growth-rate to be
applied to diffuse size geodesically
(along the surface).
• Choose whether to enable diffusion

of free node sizes to other free nodes
in proximity, even when they are not
connected (set diffuse-across-
free-edge? to #t or #f).
• Specify the absolute range to be used

to find free nodes in proximity for
diffusion free-diffusion-range
(when diffuse-across-free-
edge? is enabled (#t).
On Diffuse geodesic sizing on the specified (tgapi-size-field-diffuse-

object object labels. Diffusion can also happen geodesic-on-object-labels
face on face zone labels which are not 'object-name '(label-name-
zone specified, if they can be reached by list) min-size max-size
labels node flood filling. growth-rate diffuse-across-
free-edge? free-diffusion-
• Specify the object face zone labels range)
using the object-name and the
label-name-list or label- (tgapi-size-field-diffuse-
name-pattern*. geodesic-on-object-labels
'object-name "label-name-
• Specify the minimum and maximum pattern*" min-size max-size
size limits to apply for the node size growth-rate diffuse-across-
(min-size, max-size. free-edge? free-diffusion-
range)
Important: (tgapi-size-field-diffuse-
The sizes will be "object-name" '(label-name-
bounded to the min- list) min-size max-size
size and max-size growth-rate diffuse-across-
specified. The final free-edge? free-diffusion-
minimum node size range)
will be the maximum (tgapi-size-field-diffuse-
of (node-min-size, geodesic-on-object-labels
min-size) and final "object-name" "label-name-
maximum node size pattern*" min-size max-size
will be the minimum growth-rate diffuse-across-
of (node-max-size, free-edge? free-diffusion-
max-size). range)
• Specify the growth-rate to be

applied to diffuse size geodesically
(along the surface).

• Choose whether to enable diffusion
of free node sizes to other free nodes
in proximity, even when they are not
connected (set diffuse-across-
free-edge? to #t or #f).
• Specify the absolute range to be used

to find free nodes in proximity for
diffusion free-diffusion-range
(when diffuse-across-free-
edge? is enabled (#t).
D.1. Examples
Consider a model with face zones part1, part2, part3, inlet1, inlet2, and outlet.
• Initialize geodesic sizes for the face zones.
(tgapi-size-field-initialize-geodesic-on-face-zones '(inlet1 outlet)

32.0)
(tgapi-size-field-initialize-geodesic-on-face-zones "part*" 64.0)
• Compute the geodesic sizes for curvature size controls.
(tgapi-size-field-compute-geodesic 'curvature*)
• Compute the volumetric sizes for BOI size controls.
(tgapi-size-field-compute-volumetric 'boi*)
Compute the geodesic blended size field.
(tgapi-size-field-compute-geodesic-blended '*)
• Remove refined surface mesh clusters generated by geodesic sizing on the specified face zones.
(tgapi-size-field-filter-noise-geodesic "part*" 1.6 40)
• Update geodesic sizes with volumetric sizes on selected object face zone labels.
(tgapi-size-field-update-geodesic-with-volumetric-on-face-zones 'part*)
• Scale geodesic sizes on marked faces for face zones.
(tgapi-size-field-scale-geodesic-on-marked-faces '(inlet1 outlet) 0.5

0.15 256)
• Scale geodesic sizes on face zones.
(tgapi-size-field-scale-geodesic-on-face-zones "part*" 0.7 0.15 256)
Examples
Consider a model with objects part1, part2, and part3, inlet1, inlet2, and outlet.
• Initialize geodesic sizes for objects.
(tgapi-size-field-initialize-geodesic-on-objects '(inlet1 inlet2 outlet)

32.0)
(tgapi-size-field-initialize-geodesic-on-objects 'part* 64.0)
• Remove refined surface mesh clusters generated by geodesic sizing on the face zones of mesh objects.
(tgapi-size-field-filter-noise-geodesic (get-face-zones-of-objects
(tgapi-util-get-object-name-list-of-type 'mesh)) 1.6 40)
• Update geodesic sizes with volumetric sizes on selected face zones.
(tgapi-size-field-update-geodesic-with-volumetric-on-objects '(inlet1
inlet2 outlet))
• Scale geodesic sizes on objects.
(tgapi-size-field-scale-geodesic-on-objects ‘part* 0.5 0.15 256)
Consider a model with mesh object _fluid with face zone labels part1, part2, and part3, inlet1, inlet2,
and outlet.
• Initialize geodesic sizes for object face zone labels.
(tgapi-size-field-initialize-geodesic-on-object-labels ‘_fluid '(inlet1

outlet) 32.0)
(tgapi-size-field-initialize-geodesic-on-object-labels ‘_fluid "part*"

64.0)
• Update geodesic sizes with volumetric sizes on selected object face zone labels.
(tgapi-size-field-update-geodesic-with-volumetric-on-object-labels
'_fluid '(inlet1 outlet))
• Scale geodesic sizes on object face zone labels.
(tgapi-size-field-scale-geodesic-on-object-labels '_fluid "part*" 0.7

0.15 256)
Appendix E. Wrap Functions
Wrapping functions are available for generating the surface mesh for automotive applications for un-
derhood thermal management (UTM) and external-aero analysis. Note that periodic meshes are not
supported.
The following wrap functions are available.
Note:

Wrap objects Creates the wrapper surface based on the (tgapi-wrap-objects '(object-
objects and material point specified. The list) 'new-object-name "mater-
wrapper surface creation involves ial-point-name" "sizing-type")
operations such as Octree creation, (tgapi-wrap-objects '(object-
intersection, interface creation, projection list) "new-object-name" "mater-
and zone separation. ial-point-name" "sizing-type")
• Specify the objects using an object- (tgapi-wrap-objects "object-
list or object-name-pattern*. name-pattern*" 'new-object-
name "material-point-name"
• Specify a name for the new object. "sizing-type")
• Specify the material point ("materi- (tgapi-wrap-objects "object-

al-point-name") to be used for the name-pattern*" "new-object-
wrap operation. name" "material-point-name"
"sizing-type")
• Specify the sizing type (set "sizing-
type" to "geodesic" or "volumet-
ric".
Note:
The size field should be

computed prior to
invoking this API.
Wrap objects Similar to tgapi-wrap-objects with (tgapi-wrap-objects-with-seals

with seals the addition of seal objects that are used object-name-list-or-pattern
during interface creation and projection 'new-object-name "material-
only, in order to prevent leaks. Seal point-name" "sizing-type"
objects do not participate in imprinting
Wrap Functions

and are not associated with the seal-object-name-list-or-pat-
underlying geometry. tern)
• Specify the objects using an object-

name (string or symbol) or object-
list (string or symbol) or object-
name-pattern* (string or symbol).
• Specify a name for the new object.
• Specify the material point ("materi-

al-point-name") to be used for the
wrap operation.

ric".
Note:

computed prior to
invoking this API.
• Specify the seal objects using an ob-

ject-name (string or symbol) or ob-
ject-list (string or symbol) or ob-
ject-name-pattern* (string or
symbol).
Imprint object Imprint feature edges on given mesh (tgapi-wrap-imprint-object-

features object, and returns feature path extracted features 'mesh-object-name
after imprint. separate-off-geometry-edges?
relative-distance critical-
• Specify the mesh object using the angle)
mesh-object-name.
(tgapi-wrap-imprint-object-
• Choose whether to delete feature path features "mesh-object-name"
edges far from geometry. Set separ- separate-off-geometry-edges?
ate-off-geometry-edges? to #t relative-distance critical-
or #f. angle)
• Specify the distance tolerance (relat-

ive-distance) and angle tolerance
(critical-angle) to determine the
features far from the geometry, when
separate-off-geometry-edges?
is set to #t.
Smooth Face Smooth face nodes while preserving the (tgapi-wrap-smooth-face-zones-
face zones features for the face zones specified. with-features-preserved
nodes specified '(face-zone-id-list) mean-
• Specify the face zones using a face- filter-iterations median-fil-
zone-id-list, face-zone-name- ter-iterations number-of-lay-
list, or face-zone-name-pat- ers)
tern*.
(tgapi-wrap-smooth-face-zones-
• Specify the number of mean filter with-features-preserved
iterations (mean-filter-itera- '(face-zone-name-list) mean-
tions). Mean filters use the average of filter-iterations median-fil-
adjacent face normal for smoothing. This ter-iterations number-of-lay-
method is better for smoothing spikes ers)
(tgapi-wrap-smooth-face-zones-
• Specify the number of median filter with-features-preserved "face-
iterations (median-filter-itera- zone-name-pattern*" mean-fil-
tions). Median filters use the median ter-iterations median-filter-
of adjacent face normal for smoothing. iterations number-of-layers)
This method is better for feature
preservation
• Specify the number of layers (number-

of-layers) to be smoothed.
Note:
You can use the mean

and median filters
individually or use both
together.
Object Smooth face nodes while preserving the (tgapi-wrap-smooth-object-la-

face features for the object face zone labels bels-with-features-preserved
zone specified. 'mesh-object-name '(face-zone-
labels label-list) mean-filter-itera-
specified • Specify the mesh object and the face tions median-filter-iterations
zone labels using a face-zone-la- number-of-layers)
bel-list or face-zone-label-
(tgapi-wrap-smooth-object-la-
name-pattern*.
bels-with-features-preserved
• Specify the number of mean filter 'mesh-object-name "face-zone-
iterations (mean-filter-itera- label-name-pattern*" mean-
tions). Mean filters use the average of filter-iterations median-fil-
adjacent face normal for smoothing. This ter-iterations number-of-lay-
method is better for smoothing spikes ers)
• Specify the number of median filter bels-with-features-preserved
iterations (median-filter-itera- "mesh-object-name" '(face-
tions). Median filters use the median zone-label-list) mean-filter-
of adjacent face normal for smoothing.
Wrap Functions

This method is better for feature iterations median-filter-iter-
preservation ations number-of-layers)
bels-with-features-preserved
of-layers) to be smoothed.
"mesh-object-name" "face-zone-
label-name-pattern*" mean-
Note: filter-iterations median-fil-
ter-iterations number-of-lay-
You can use the mean ers)
and median filters
individually or use both
together.
Face Smooth the face nodes of the mesh (tgapi-wrap-smooth-object-off-

nodes object which are far from the geometry. geometry-faces 'mesh-object-
far Specify the mesh object. name)
from (tgapi-wrap-smooth-object-off-
geometry geometry-faces "mesh-object-
name")
Separate object Separate the mesh object face zones (tgapi-wrap-separate-object-
face zones based on the underlying geometry. face-zones 'mesh-object-name
remove-saw-tooth-configura-
• Specify the mesh object. tions? saw-tooth-feature-
angle)
• Choose whether to remove saw tooth
configurations (set remove-saw- (tgapi-wrap-separate-object-
tooth-configurations? to #t or face-zones "mesh-object-name"
#f). remove-saw-tooth-configura-
tions? saw-tooth-feature-
Specify an appropriate value for angle)
saw-tooth-feature-angle.
This is used to identify angle-based
features so as to avoid removal of
saw-tooth configurations, while
separating zones. For example, at
the corner of a cuboid formed by
six planar zones, a corner face is
topologically a saw tooth
configuration, but will not be
rezoned if the saw-tooth-fea-
ture-angle specified is less than
90 degree. The recommended
range is 30 to 60 degrees.
Remesh mesh Remesh the mesh object based on the (tgapi-wrap-remesh-object

object sizing type specified. 'mesh-object-name feature-min-
angle feature-max-angle
• Specify the mesh object. corner-angle "sizing-type"
• Specify the feature-min-angle and respect-zone-boundary? front-
feature-max-angle. The fea- intersection-tolerance)
ture-min-angle and feature- (tgapi-wrap-remesh-object
max-angle limits are used to retain "mesh-object-name" feature-
angle-based features. The min-angle feature-max-angle
recommended value for feature- corner-angle "sizing-type"
max-angle is 180. respect-zone-boundary? front-
intersection-tolerance)
• Specify the corner-angle. The
remeshing.

ric").
Note:

computed prior to
invoking this API.
• Specify if you want to respect zone

boundaries.

Delete unwetted Separate and delete the object faces that (tgapi-wrap-delete-unwetted-
object faces are not in the region of the given material object-faces 'mesh-object-name
points. material-point-name-list-or-
pattern)
• Specify the mesh object.
• Specify the objects using a material-

point-name-list or material-
point-name-pattern*.
Resolve face Resolve face intersections for the mesh (tgapi-wrap-resolve-face-inter-

intersections object specified. sections-in-object 'mesh-ob-
ject-name)
Wrap Functions

(tgapi-wrap-resolve-face-inter-
sections-in-object "mesh-ob-
ject-name")
Inflate By Inflate mesh object faces based on the (tgapi-wrap-inflate-object-
object dihedral dihedral angle specified. faces-by-dihedral-angle 'mesh-
faces angle object-name minimum-dihedral-
• Specify the mesh object. angle absolute-min-offset rel-
ative-min-offset number-of-
• Specify an appropriate value for minim- iterations remove-saw-tooth-
um-dihedral-angle. The minim- configurations?)
um-dihedral-angle is the angle
between faces connected by an edge. (tgapi-wrap-inflate-object-
The faces will be inflated if the angle is faces-by-dihedral-angle "mesh-
less than the specified value. object-name" minimum-dihedral-
angle absolute-min-offset rel-
• Specify the absolute-min-offset ative-min-offset number-of-
and relative-min-offset. iterations remove-saw-tooth-
configurations?)
The absolute-min-offset is
the absolute distance used to
move the nodes to increase the
gap. The relative-min-off-
set is the relative distance (as a
factor of local edge length) used
to move the nodes.
• Specify the number of iterations (num-

ber-of-iterations).

configurations (set remove-saw-
tooth-configurations? to #t or
#f.
By Inflate mesh object faces based on invalid (tgapi-wrap-inflate-object-

invalid normals. faces-by-invalid-normal 'mesh-
normal object-name number-of-layers
• Specify the mesh object. absolute-min-offset relative-
min-offset number-of-itera-
• Specify an appropriate value for num- tions remove-saw-tooth-config-
ber-of-layers. The number-of- urations?)
layers is the number of layers of face
nodes around the invalid normal (tgapi-wrap-inflate-object-
location to be inflated. faces-by-dihedral-angle "mesh-
object-name" number-of-layers
• Specify the absolute-min-offset absolute-min-offset relative-
and relative-min-offset. min-offset number-of-itera-
tions remove-saw-tooth-config-
The absolute-min-offset is urations?)
the absolute distance used to
move the nodes to increase the
gap. The relative-min-off-
set is the relative distance (as a
factor of local edge length) used
to move the nodes.
• Specify the number of iterations (num-

ber-of-iterations).

configurations (set remove-saw-
tooth-configurations? to #t or
#f.
Improve Improve Improve the mesh object quality. (tgapi-wrap-improve-object-

mesh mesh quality 'mesh-object-name ag-
object object • Specify the mesh object. gressively?)
quality (tgapi-wrap-improve-object-
• Enable aggressive improvement if
required (set aggressively? to #t quality "mesh-object-name"
or #f. When this option is enabled, the aggressively?)
features may not be preserved during
the improve operation.
For tet Improve mesh object for tet meshing. (tgapi-wrap-improve-object-

meshing for-tet-meshing 'mesh-object-
• Specify the mesh object. name "material-point-name"
max-cell-skewness max-face-
• Specify the material point ("materi- skewness max-face-size-change)
al-point-name").
(tgapi-wrap-improve-object-
• Set the max-cell-skewness, max- for-tet-meshing "mesh-object-
face-skewness, and max-face- name" "material-point-name"
size-change. max-cell-skewness max-face-
skewness max-face-size-change)
For Improve mesh object for prism meshing. (tgapi-wrap-improve-object-
prism In general, zones will inherit the prism for-prism-meshing 'mesh-ob-
meshing settings from the underlying geometry. ject-name number-of-layers
For zones that do not inherit prism "offset-method" prism-aspect-
settings, the settings passed as arguments ratio last-ratio-percentage
will be used. prism-layer-first-height
prism-layer-growth-rate qual-
• Specify the mesh object. ity-measure max-cell-skewness
max-face-skewness keep-
prisms?)
of-layers). The number of layers
should be the same as that set for prism (tgapi-wrap-improve-object-
meshing. for-prism-meshing "mesh-ob-
ject-name" number-of-layers
• Set the prism offset-method. Select offset-method prism-aspect-
one of the options "aspect-ratio", ratio last-ratio-percentage
Wrap Functions

"last-ratio", "uniform", or prism-layer-first-height
"minimum-height". prism-layer-growth-rate qual-
ity-measure max-cell-skewness
• Set the prism-aspect-ratio, if max-face-skewness keep-
applicable. prisms?)
• Set the last-ratio-percentage,
if applicable.
• Set the prism-layer-first-

height.
• Set the prism-layer-growth-

rate.
• Specify the quality-measure to be

used.
• Set the max-cell-skewness and

max-face-skewness.
• Choose whether to retain the prisms (set

keep-prisms? to #f or #t) (setting
to #t requires beta features to be
enabled).
Note:
A value of -1 can be used

for the parameters that
are not required for a
particular offset method.
E.1. Examples
For a model with geometry objects part1, part2, part3 and material point fluid:
• Compute the size field.
• Wrap the geometry objects using the material point fluid.
(tgapi-wrap-objects 'part* '_fluid "fluid" "geodesic")
• Imprint feature edges on the mesh object.
(tgapi-wrap-imprint-object-features '_fluid #t 0.2 15)
• Smooth face nodes while preserving features.
Examples
(tgapi-wrap-smooth-face-zones-with-features-preserved (get-face-zones-
of-objects '(_fluid)) 5 15 0)
• Smooth the face nodes of the mesh object which are far from the geometry.
(tgapi-wrap-smooth-object-off-geometry-faces '_fluid)
• Remesh the mesh object.
(tgapi-wrap-remesh-object '_fluid 40.0 180.0 180.0 "geodesic" #f 0.0)
• Improve the mesh object quality.
(tgapi-wrap-improve-object '_fluid #t)
• Resolve thin regions and self intersections.
(tgapi-wrap-inflate-object-faces-by-invalid-normal '_fluid 2 0.0 0.2 2

#t)
(tgapi-wrap-inflate-object-faces-by-dihedral-angle '_fluid 10 0.0 0.2

2 #t)
(tgapi-wrap-resolve-face-intersections-in-object '_fluid)
• Improve mesh object for tet meshing.
(tgapi-wrap-improve-object-for-tet-meshing '_fluid "fluid" 0.96 0.8 2.0)
• Improve mesh object for prism meshing.
(tgapi-wrap-improve-object-for-prism-meshing '_fluid 1 "aspect-ratio"

5 -1 -1 1.2 "inverse-ortho" 0.97 0.9 #f)
Note:
A value of -1 has been used for the parameters that are not required for the offset
method chosen.
• Remove unwetted object faces.
(tgapi-wrap-delete-unwetted-object-faces ‘wrap-v2 ‘ext*)
(tgapi-wrap-delete-unwetted-object-faces “wrap-v2” (list “external”

“mat-pt1”))
(tgapi-wrap-delete-unwetted-object-faces “wrap-v2” “mat-pt1”)
• Separate the mesh object face zones based on the geometry.
(tgapi-wrap-separate-object-face-zones '_fluid #t 0.0)
Part III: Solution Mode
The section describes the text command listing for Fluent in Solution mode.
• adapt/ (p. 213) lists commands related to mesh adaption.
• adjoint/ (p. 217) lists commands related to the adjoint solver.
• define/ (p. 225) lists commands related to problem definition, such as models, boundary conditions, ma-
terials, etc.
window.
• exit / close-fluent (p. 319) lists the command to close the program.
• mesh/ (p. 333) lists commands used to create and manage mesh properties.
• plot/ (p. 343) lists commands specific to plotting data.
• report/ (p. 347) lists commands used to return statistics for the simulation.
• server/ (p. 355) lists commands used control the Fluent Remote Visualization Client and Server.
• solve/ (p. 357) lists commands used to create and manage solution controls, such as animation, cell registers,
monitors, initialization, etc.
• surface/ (p. 381) lists commands related to creating and manipulating surfaces.
• switch-to-meshing-mode (p. 383) lists the command to transfer your solution data to Fluent in meshing
mode.
• turbo-post/ (p. 385) lists commands related to results and reporting for turbomachinery.
• views/ (p. 387) lists commands related to camera and view manipulation in the graphics window.
• battery-model/ (p. 389) lists commands related to battery models.
• Fuel Cell Text Commands (p. 393) lists commands related to fuel cell models.
• Magnetohydrodynamics Text Commands (p. 403) lists commands related to magnetohydrodynamics models.
Chapter 1: adapt/
Important:
The adapt/ text command menu is only available if you have used the following text
command: mesh/adapt/revert-to-R19.2-user-interface. Accessing the adapt/
text command menu in this way will not be possible in future releases.
adapt-boundary-cells
Adapts boundary cells based on a list of face zones.
adapt-to-gradients
Adapts mesh based on the gradient adaption function from the selected scalar quantity, the adaption
threshold values, and the adaption limits.
adapt-to-ref-lev
Adapts cells based on refinement level differences.
adapt-to-register
Adapts mesh based on the selected register and adaption limits.
adapt-to-vol-change
Adapts cells with large changes in cell volume.
adapt-to-volume
Adapts cells that are larger than a prescribed volume.
adapt-to-y+
Adapts cells associated with all wall zones based on the specified threshold values and adaption limits.
adapt-to-y+-zones
Adapts cells associated with specified wall zones based on the specified threshold values and adaption
limits.
anisotropic-adaption
Anisotropically refines boundary layers. Cells will be split in the normal direction to the boundary face.
adapt-to-y*
Adapts cells associated with all wall zones based on the specified threshold values and adaption limits.
adapt-to-y*-zones
Adapts cells associated with specified wall zones based on the specified threshold values and adaption
limits.
change-register-type
Toggles specified register between refinement and mask.
adapt/
combine-registers
Combines the selected adaption and/or mask registers to create hybrid adaption functions.
delete-register
Deletes a register.
display-register
Displays the cells marked for adaption in the specified register.
exchange-marks
Exchanges the refinement and coarsening marks of the specified register.
fill-crsn-register
Marks all cells to coarsen that are not marked for refinement in the register.
free-parents
Deletes the hanging node face and cell hierarchy.
free-registers
Deletes all adaption and mask registers.
invert-mask
Changes all the active cells to inactive cells in a mask register.
limit-register
Applies the adaption volume limit to the selected register.
list-registers
Prints a list of the current registers including the ID, description (name), number of cells marked for refine-
ment and coarsening, and the type.
mark-boundary-cells
Marks boundary cells based on a list of zones for refinement.
mark-boundary-normal
Marks cells for refinement based on target boundary normal distance.
mark-boundary-vol
Marks cells for refinement based on target boundary volume.
mark-inout-circle
Marks cells with centroids inside/outside the circular region defined by text or mouse input.
mark-inout-cylinder
Marks cells with centroids inside/outside the arbitrarily oriented cylindrical region defined by text or mouse
input.
mark-inout-hexahedron
Marks cells with centroids inside/outside the hexahedral region defined by text or mouse input.
mark-inout-iso-range
Marks cells for refinement that have values inside/outside the specified isovalue ranges of the selected
field variable.
mark-inout-rectangle
Marks cells with centroids inside/outside the rectangular region defined by text or mouse input.
mark-inout-sphere
Marks cells with centroids inside/outside the spherical region defined by text or mouse input.
mark-percent-of-ncells
Marks percent of total cell count for adaption based on gradient or isovalue.
mark-with-gradients
Marks cells for adaption based on flow gradients for refinement.
mark-with-ref-lev
Marks cells based on refinement level differences.
mark-with-vol-change
Marks cells with large changes in cell volume for refinement.
mark-with-volume
Marks cells for adaption based on maximum allowed volume.
mark-with-y+
Marks cells associated with all wall zones for refinement or coarsening based on the specified threshold
values.
mark-with-y+-zones
Marks only cells associated with specified wall zones for refinement or coarsening based on the specified
threshold values.
mark-with-y*
Marks cells associated with all wall zones for refinement or coarsening based on the specified threshold
values.
mark-with-y*-zones
Marks only cells associated with specified wall zones for refinement or coarsening based on the specified
threshold values.
set/
Enters the adaption set menu.
cell-zones
Sets cell zones to be used for marking adaption.
coarsen-mesh?
Turns on/off ability to coarsen mesh.
display-crsn-settings
Prompts for coarsening wireframe visibility and shading, and the marker visibility, color, size and
symbol.
display-node-flags
Displays s color coded markers at the nodes specifying the node type.
adapt/
display-refn-settings
Prompts for refinement wireframe visibility and shading, and the marker visibility, color, size and
symbol.
grad-vol-weight
Controls the volume weighting for the gradient adaption function.
init-node-flags
Initializes the node flags.
max-level-refine
Sets maximum level of refine in the mesh.
max-number-cells
Limits the total number of cells produced by refinement.
method
Sets the adaption method.
min-cell-quality
Sets the minimum value allowed for the orthogonal quality of cells during adaption. If your solution
diverges, you may find that using a higher minimum quality value resolves the issue. This text command
is only available with the PUMA 3D adaption method.
min-cell-volume
Restricts the size of the cells considered for refinement.
min-number-cells
Sets limit on the number of cells in the mesh.
reconstruct-geometry
Enables/disables geometry-based adaption.
refine-mesh?
Turns on/off mesh adaption by point addition.
set-geometry-controls
Sets geometry controls for wall zones.
verbosity
Allows to set the adaption verbosity.
smooth-mesh
Smooths the mesh using the quality-based, Laplacian, or skewness methods.
swap-mesh-faces
Swaps the faces of cells that do not meet the Delaunay circle test.
Chapter 2: adjoint/
controls/
Menu to configure adjoint solver controls.
settings
Sets parameters for the adjoint solver numerics.
stabilization
Sets parameters for the adjoint stabilization schemes.
stabilization-strategy
Enters the stabilization strategy menu, where you can define the stabilization strategy and settings
for the adjoint solver.
complex-case-settings
Defines the settings that are recommended for complex cases.
default-settings
Defines settings that are recommended for standard cases. These settings are used by default.
settings
Allows you to define a custom settings.
type
Allows you to define the stabilization strategy type.
design-tool/
Enters the design-tool menu.
design-change/
Performs optimal shape modification.
calculate-design-change
Computes the optimal design change.
check
Prints a report in the console that summarizes the control points defined for the region, the defined
constraining and/or deformation conditions, and any possible conflicts between multiple constraints
/ deformations applied on a single node.
display-applied-conditions
Displays all of the applied conditions in the graphics window, each type in a unique color. Note
that this includes the selected design conditions, as well as the fixed conditions applied to zones
that are not selected for deformation.
export-displacements
Exports the computed optimal displacements.
adjoint/
export-stl
Exports specified surfaces from 3D cases as an .stl file.
modify-mesh
Applies the computed optimal displacement to the mesh.
multiobjective-weights
Sets the weights for multiple free-form objectives.
preview-mesh
Displays the planned changes in the graphics window for select surfaces (undeformed in white,
deformed in green).
print-expected-changes
Prints the expected changes.
revert-mesh
Reverts (rejects) the last mesh modification.
select-conditions
Selects which conditions to apply to the mesh deformation.
select-morphing-method
Selects the morphing method.
select-strict-conditions
Selects constraining and/or deformation conditions you want strictly enforced (that is, applied to
all of the nodes of the associated zones).
select-zones
Selects which zones are allowed to deform.
settings
Specifies global deformation scale and settings.
write-expected-changes
Writes out the expected changes in the observables for the computed optimal design change.
design-conditions/
Creates, deletes, displays (with various options), renames, and/or sets conditions on the geometry
deformation.
numerics
Adjusts numerics settings for computing the optimal displacement.
objectives/
Menu to configure observable objectives.
include-current?
Optionally includes the most-recently computed observable sensitivity in the multi-objective design
computation.
manage/
Menu to import, export, and manage sensitivity data.
set
Configures the objectives for loaded observables.
region-conditions/
Menu to configure conditions on the deformation region
boundaries
Specifies what degree of continuity to enforce at the boundaries of the deformation region.
motion
Specifies conditions on the movement of the control points.
points
Specifies the number of control points in the deformation region.
symmetry
Specifies symmetry conditions for the deformation region.
region/
Menu to define the deformation region.
cartesian-limits
Directly specifies the bounds of the Cartesian deformation region.
cylindrical-limits
Directly specifies the bounds of the cylindrical deformation region.
export-sensitivities
Exports the sensitivity to mesh node movement for the currently selected observable. Sensitivities
are only exported for mesh nodes that lie within the specified deformation region.
get-bounds
Sets the limits for the deformation region to encompass a list of selected surfaces.
larger-box
Uniformly increases the size of the deformation region.
set-region-type
Specifies whether the deformation region is either a Cartesian or cylindrical region type.
smaller-box
Uniformly decreases the size of the deformation region.
expert/
Provides text commands that allow you to undo enhancements to the default adjoint solver behavior.
undo-2019r3-default-changes?
Allows you to undo an enhancement introduced in version 2019 R3 of ANSYS Fluent: the use of a full
(rather than a flexible) cycle algebraic multigrid (AMG) solver in the adjoint solver, which can improve
convergence and efficiency.
undo-r19.2-default-changes?
Allows you to undo enhancements introduced in version 19.2 of ANSYS Fluent, including a modified
Rhie-Chow averaging method (to be consistent with default changes introduced in the general solver
in version 19.0), a non-conservative form of the adjoint equations, an enhanced method for building
adjoint/
the algebraic multigrid (AMG) matrix for the adjoint solver, and a disabling of the early protection
scheme used by the AMG solver for the adjoint calculations.
methods/
Menu to configure adjoint solver settings.
settings
Defines settings such as spatial discretization methods for the adjoint solver.
default-settings
Applies defaults to adjoint solver settings such as spatial discretization methods.
best-match-settings
Defines settings such as spatial discretization methods for the adjoint solver to match those for the
flow solver as closely as possible.
monitors/
Menu to configure monitors for the adjoint solver.
plot-residuals
Plots the adjoint residuals in the designated graphics window.
settings
Allows you to configure the monitors and convergence criteria for the adjoint solver.
observable/
Menu to create and configure observables of interest.
create
A new observable of the specified type and name is created and the definition is populated with default
parameters.
delete
Removes a named observable.
evaluate
Evaluates the current value of the selected observable and prints the result to the console.
rename
An existing observable is renamed to a new specified name.
select
A named observable is selected as the one for which an adjoint solution is to be computed.
specify
The parameters that define a named observable are configured.
write
Evaluates the current value of the selected observable and writes the result to a file.
optimizer/
Enters the optimizer menu, where you can use a gradient-based optimizer to optimize the geometry to
meet multiple goals for multiple observables at multiple operating conditions.
calculate\
Enters the calculate menu, for running the gradient-based optimizer.
initialize
Initializes the optimizer and clears out the optimization history.
optimize
Runs adjoint-based optimization.
reset
Sets the current design iteration as the optimal solution.
summarize
Reports the optimization history.
calculation-activities/
Enters the calculation-activities menu, for setting activities during the adjoint optimization.
animate/
Enters the animate menu, for outputting plots for animations every design iteration.
define/
Enters the animation definition menu.
define-monitor
Defines new animation.
edit-monitor
Change animation monitor attributes.
objects/
Enters the objects menu to define, edit, delete solution animation objects.
clear-history
Clears object history.
copy
Copies graphics object.
create
Creates new graphics object.
delete
Deletes graphics object.
edit
Edits graphics object.
playback/
Enters the animation playback menu.
delete
Deletes animation sequence.
adjoint/
play
Plays the selected animation.
read
Reads new animation from file or already-defined animations.
stored-view?
Plays the 3D animation sequence using the view stored in the sequence.
write
Writes animation sequence to the file.
auto-save
Saves files at a specified frequency of design iterations.
execute-commands/
Enters the execute-commands menu.
add-edit
Adds or edits a command so that it can be enabled to be executed during the adjoint optimiz-
ation.
disable
Disables a command so that it is not executed during the adjoint optimization.
enable
Enables a command so that it is executed during the adjoint optimization.
monitor
Monitors the adjoint optimization.
plot
Plots monitors.
settings
Settings for monitors.
mesh-quality\
Enters the mesh-quality menu, for printing and setting the requirement of mesh quality during the
adjoint optimization.
mesh-quality-settings
Sets the requirement of mesh quality during the adjoint optimization.
print-current-status
Prints the current mesh quality status.
optimizer-objectives/
Enters the optimizer-objectives menu, for setting the objectives in the adjoint optimizer.
set-adaptive-change
Sets adaptive change.
set-conditions
Sets operating conditions.
set-objectives
Sets multi-objectives.
set-observables
Choose observables.
optimizer-settings
Sets the settings in the adjoint optimizer.
reporting/
Menu to report sensitivity data from the adjoint solution.
report
Reports sensitivity data on a named flow boundary.
write
Reports sensitivity data on a named flow boundary and writes it to a named file.
run/
Menu to initialize and compute the adjoint solution.
calculation-activities/
Enters the calculation-activities menu, for setting activities during the adjoint calculation.
auto-save
Saves case and data files at a specified frequency of adjoint iterations.
execute-commands/
Enters the execute-commands menu.
add-edit
Adds or edits a command that can be enabled to be executed during the adjoint calculation.
disable
Disables a command so that it is not executed during the adjoint calculation.
enable
Enables a command so that it is executed during the adjoint calculation.
initialize
Initializes the adjoint solution field to zero everywhere.
initialize-stabilization
Initializes the stabilization data. This text command is only available if the residual minimization or
modal stabilization is used.
initialize-strategy
Initializes the stabilization strategy, such that the first stabilization scheme is used at the start of the
next calculation rather than continuing to use the second stabilization scheme. This text command is
only available when the blended stabilization strategy is used.
iterate
Advances the adjoint solver by a specified number of iterations, or until the convergence criteria are
met.
Chapter 3: define/
Enters the boundary conditions menu.
Important:
Text User Interface commands that take single or multiple zone names support the use
of wildcards. For example, to copy boundary conditions (copy-bc) to all zones of a
certain type, use a * in the name of the zone to which you want to copy the conditions.
axis
Sets boundary conditions for a zone of this type.
bc-settings/
Enters the boundary conditions settings menu.
mass-flow
Selects method for setting the mass flow rate.
pressure-outlet
Sets advanced options for pressure outlet boundaries.
copy-bc
Copies boundary conditions to other zones.
degassing
exhaust-fan
fan
fluid
inlet-vent
intake-fan
interface
define/
interior
list-zones
Prints out the types and IDs of all zones in the console window. You can use your mouse to check a
zone ID, following the instructions listed under Zone in the Boundary Conditions Task Page section
of the User’s Guide.
mass-flow-inlet
mass-flow-outlet
modify-zones/
Enters the modify zones menu.
activate-cell-zone
Activates cell thread.
append-mesh
Appends new mesh.
append-mesh-data
Appends new mesh with data.
change-zone-state
Sets the state (liquid or vapor) for a specific fluid zone.
copy-move-cell-zone
Creates a copy of a cell zone that is offset from the original either by a translational distance or a
rotational angle. In the copied zone, the bounding face zones are all converted to walls, any existing
cell data is initialized to a constant value, and non-conformal interfaces and dynamic zones are
not copied; otherwise, the model settings are the same as in the original zone. Note that if you
want the copied zone to be connected to existing zones, you must either fuse the boundaries (see
Fusing Face Zones in the Fluent User's Guide) or set up a non-conformal interface (see Using a Non-
Conformal Mesh in ANSYS Fluent in the Fluent User's Guide).
copy-mrf-to-mesh-motion
Copies motion variable values for origin, axis, and velocities from Frame Motion to Mesh Motion.
copy-mesh-to-mrf-motion
Copies motion variable values for origin, axis, and velocities from Mesh Motion to Frame Motion.
create-all-shell-threads
Marks all finite thickness walls for shell creation. Shell zones will be created at the start of the iter-
ations.
create-periodic-interface
Creates a conformal or non-conformal periodic interface.
deactivate-cell-zone
Deactivates cell thread.
delete-all-shells
Deletes all shell zones and switches off shell conduction on all the walls. These zones can be recre-
ated using the command recreate-all-shells.
delete-cell-zone
Deletes a cell thread.
extrude-face-zone-delta
Extrudes a face thread a specified distance based on a list of deltas.
extrude-face-zone-para
Extrudes a face thread a specified distance based on a distance and a list of parametric locations
between 0 and 1, for example, 0 0.2 0.4 0.8 1.0.
fuse-face-zones
Attempts to fuse zones by removing duplicate faces and nodes.
list-zones
Lists zone IDs, types, kinds, and names.
make-periodic
Attempts to establish periodic/shadow face zone connectivity.
matching-tolerance
Sets normalized tolerance used for finding coincident nodes.
merge-zones
Merges zones of same type and condition into one.
mrf-to-sliding-mesh
Changes the motion specification from MRF to moving mesh.
orient-face-zone
Orients the face zone.
recreate-all-shells
Recreates shells on all the walls that were deleted using the command delete-all-shells.
replace-zone
Replaces cell zone.
sep-cell-zone-mark
Separates cell zone based on cell marking.
sep-cell-zone-region
Separates cell zone based on contiguous regions.
sep-face-zone-angle
Separates face zone based on significant angle.
sep-face-zone-face
Separates each face in zone into unique zone.
sep-face-zone-mark
Separates face zone based on cell marking.
define/
sep-face-zone-region
Separates face zone based on contiguous regions.
slit-periodic
Slits periodic zone into two symmetry zones.
slit-face-zone
Slits two-sided wall into two connected wall zones.
slit-interior-between-diff-solids
Slits the interior zone between solid zones of differing materials to create a coupled wall. You will
generally be prompted by Fluent if this is necessary.
zone-name
Gives a zone a new name.
zone-type
Sets the type for a zone or multiple zones of the same category. You will be prompted for the name
/ ID of the zone to be changed and the new type for that zone. To change multiple zones, you can
enter a list (separated by spaces and contained within a pair of parentheses) or use asterisks (*) as
wildcards.
non-overlapping-zone-name
Displays the name of the non-overlapping zone associated with a specified interface zone. This text
command is only available after a mesh interface has been created.
non-reflecting-bc/
Enters the non-reflecting boundary condition menu.
general-nrbc/
Setting for general non-reflecting b.c.
set/
Enters the setup menu for general non-reflecting b.c.’s.
sigma
Sets NRBC sigma factor (default value 0.15).
sigma2
Sets NRBC sigma2 factor (default value 5.0).
verbosity
Enables/disables nrbc verbosity scheme output.
turbo-specific-nrbc/
Enters the turbo specific nrbc menu.
enable?
Enables/disables non-reflecting b.c.’s.
initialize
Initializes non-reflecting b.c.’s.
set/
Enters the set menu for non-reflecting b.c. parameters.
discretization
Enables use of higher-order reconstruction at boundaries if available.
under-relaxation
Sets non-reflecting b.c. under-relaxation factor.
verbosity
Sets non-reflecting b.c. verbosity level. 0 : silent, 1 : basic information (default), 2 : detailed
information for debugging.
show-status
Shows current status of non-reflecting b.c.’s.
open-channel-wave-settings
Opens channel wave input analysis.
openchannel-threads
Lists open channel group IDs, names, types and variables.
outflow
outlet-vent
periodic
phase-shift/
Enters the phase shift settings menu.
multi-disturbances
Sets basic phase-shift parameters.
extra-settings
Sets other phase-shift parameters.
porous-jump
pressure-far-field
pressure-inlet
pressure-outlet
radiator
rans-les-interface
define/
recirculation-inlet
recirculation-outlet
set/
Allows you to define one or more settings at single or multiple boundaries/cell zones of a given type
at once. Enters q to exit the define/boundary-conditions/set/<type> command.
For a description of the items in this menu, see corresponding define/boundary-condi-

tions/<type> .
shadow
solid
symmetry
target-mass-flow-rate-settings/
Enters the targeted mass flow rate settings menu.
set under-relaxation-factor
The default setting is 0.05.
enable targeted mass flow rate verbosity?

Enables/disables verbosity when using targeted mass flow rate. When enabled, it prints to the
console window the required mass flow rate, computed mass flow rate, mean pressure, the new
pressure imposed on the outlet, and the change in pressure in SI units.
velocity-inlet
wall
zone-name
Gives a zone a new name.
zone-type
Sets the type for a zone or multiple zones of the same category. You will be prompted for the name /
ID of the zone to be changed and the new type for that zone. To change multiple zones, you can enter
a list (separated by spaces and contained within a pair of parentheses) or use asterisks (*) as wildcards.
custom-field-functions/
Enters the custom field functions menu.
define
Defines a custom field function.
delete
Deletes a custom field function.
example-cff-definitions
Lists example custom field functions.
list-valid-cell-function-names
Lists the names of cell functions that can be used in a custom field function.
load
Loads a custom field function.
save
Saves a custom field function.
dynamic-mesh/
Enters the dynamic mesh menu.
actions/
Enters the dynamic mesh action menu, where you can initiate manual remeshing (that is, remeshing
without running a calculation).
remesh-cell-zone
Manually remeshes a cell zone with option to remesh adjacent dynamic face zones.
controls/
Enters the dynamic mesh controls menu. This text command is only available when the define/dy-
namic-mesh/dynamic-mesh? text command is enabled.
contact-parameters/
Enters the dynamic mesh contact-parameters menu. This text command is only available when
you enable contact detection using the prompts of the define/dynamic-mesh/dynamic-
mesh? text command.
contact-threshold
Specifies threshold distance for contact detection.
contact-udf
Selects the UDF to be invoked when contact is detected.
contact-zones
Selects face zones involved in contact detection.
flow-control?
Enables/disables flow control.
flow-control-parameters/
Sets up and deletes flow control zones
create-flow-control-zone
Creates a flow control zone.
delete-flow-control-zone
Deletes a flow control zone.
verbosity
Sets the level of detail printed in the console regarding contact detection.
define/
implicit-update-parameters/
Enters the dynamic mesh implicit update menu. This text command is only available when you
enable implicit mesh updating using the prompts of the define/dynamic-mesh/dynamic-
mesh? text command.
motion-relaxation
Specifies a value (within the range of 0 to 1) for the motion relaxation, which is applied during
the implicit mesh update.
residual-criteria
Specifies the relative residual threshold that is used to check the motion convergence during
the implicit mesh update.
update-interval
Specifies the update interval (that is, the frequency in iterations) at which the mesh is updated
within a time step.
in-cylinder-output?
Enables/disables in-cylinder output.
in-cylinder-parameters/
Enters the dynamic mesh in-cylinder menu.
crank-angle-step
Specifies crank angle step size.
crank-period
Specifies the crank period.
max-crank-angle-step
Specifies maximum crank angle step size.
minimum-lift
Specifies minimum lift for in-cylinder valves.
modify-lift
Modifies lift curve (shift or scale).
piston-data
Specifies the crank radius and connecting rod length.
piston-stroke-cutoff
Specifies the cut off point for in-cylinder piston.
position-starting-mesh
Moves mesh from top dead center to starting crank angle.
print-plot-lift
Prints or plot valve lift curve.
starting-crank-angle
Specifies the initial value for the crank angle.
layering?
Enables/disables dynamic-layering in quad/hex cell zones.
layering-parameters/
Enters the dynamic mesh layering menu.
collapse-factor
Sets the factor determining when to collapse dynamic layers.
constant-height?
Enables/disables layering based on constant height, else layering based on constant ratio.
split-factor
Sets the factor determining when to split dynamic layers.
remeshing?
Enables/disables local remeshing in tri/tet and mixed cell zones.
remeshing-parameters/
Enters the dynamic mesh remeshing menu to set parameters for all remeshing methods.
cell-skew-max
Sets the cell skewness threshold above which cells will be remeshed.
face-skew-max
Sets the face skewness threshold above which faces will be remeshed.
length-max
Sets the length threshold above which cells will be remeshed.
length-min
Sets the length threshold below which cells will be remeshed.
must-improve-skewness?
Enables/disables cavity replacement only if remeshing improves the skewness.
parallel-remeshing?
Disables/enables parallel remeshing.
remeshing-after-moving?
Enables a second round of remeshing based on the skewness parameters after the boundary
has moved.
remeshing-methods
Enables/disables remeshing methods.
size-remesh-interval
Sets the interval (in time steps) when remeshing based on size is done.
sizing-funct-defaults
Sets sizing function defaults.
sizing-funct-rate
Determines how far from the boundary the increase/decrease happens.
sizing-funct-resolution
Sets the sizing function resolution with respect to shortest boundary.
define/
sizing-funct-variation
Sets the maximum sizing function increase/decrease in the interior.
sizing-function?
Enables/disables sizing function to control size based remeshing.
six-dof-parameters/
Enters the dynamic mesh six degrees of freedom (DOF) solver menu.
create-properties
Creates/edits a set of six DOF properties for rigid body motion.
delete-properties
Deletes a set of six DOF properties for rigid body motion.
list-properties
Prints summaries of the existing sets of six DOF properties for rigid body motion.
motion-history-file-name
Specifies the name and location of the six DOF motion history file.
motion-history?
Enables/disables writing position/orientation of six DOF zones to file.
second-order?
Enables/disables the second order six degrees of freedom solver.
x-component-of-gravity
Specifies x-component of gravity.
y-component-of-gravity
Specifies y-component of gravity.
z-component-of-gravity
Specifies z-component of gravity.
smoothing?
Enables/disables smoothing in cell zones.
smoothing-parameters/
Enters the dynamic mesh smoothing menu.
amg-stabilization
Sets the algebraic multigrid (AMG) stabilization method for mesh smoothing calculations that
use finite element discretization.
bnd-node-relaxation
The boundary node relaxation is used by spring smoothing. The boundary node relaxation allows
you to relax the update of the node positions at deforming boundaries. A value of 0 prevents
deforming boundary nodes from moving and a value of 1 indicates no under-relaxation.
bnd-stiffness-factor
Sets the stiffness factor for springs connected to boundary nodes.
boundary-distance-method
Sets the method used to evaluate the boundary distance for the diffusion coefficient calculation,
when diffusion-based smoothing is enabled.
constant-factor
Sets the spring constant relaxation factor.
convergence-tolerance
Sets the convergence tolerance for spring-based solver.
diffusion-coeff-function
Specifies whether the diffusion coefficient for diffusion-based smoothing is based on the
boundary distance or the cell volume.
diffusion-coeff-parameter
Sets the diffusion coefficient parameter used for diffusion-based smoothing.
diffusion-fvm?
Answering yes at the prompt changes the diffusion-based smoothing method to the cell-
based finite volume approach that was the default in releases prior to Fluent 15.0. Answering
no at the prompt changes the diffusion-based smoothing method to the default node-based
finite element method.
max-iter
Sets the maximum number of iterations for the smoothing calculations.
relative-convergence-tolerance
Sets the relative residual convergence tolerance for smoothing based on diffusion or the linearly
elastic solid model.
skew-smooth-cell-skew-max
Sets the skewness threshold, above which cells will be smoothed using the skewness method.
skew-smooth-face-skew-max
Sets the skewness threshold, above which faces will be smoothed using the skewness method.
skew-smooth-niter
Sets the number of skewness-based smoothing cycles.
smooth-from-reference-position?
Enables/disables smoothing from a reference position. Such smoothing may produce greater
mesh quality consistency for stationary or moving meshes with periodic or quasi-periodic
motion, and is only available when the smoothing method is based on diffusion or the linearly
elastic solid model.
smoothing-method
Specifies the smoothing method (spring, diffusion, or linearly elastic solid) used by the dynamic
mesh model.
spring-on-all-elements?
Enables/disables spring-based smoothing for all cell shapes; if disabled, the spring-based
smoothing is applied based on the setting of the define/dynamic-mesh/con-
trols/smoothing-parameters/spring-on-simplex-shapes? text command.
define/
spring-on-simplex-shapes?
Enables/disables spring-based smoothing for triangular / tetrahedral cells in mixed element
zones; if disabled, the spring-based smoothing is applied to triangular / tetrahedral cells in
triangular / tetrahedral element zones.
poisson-ratio
Sets the Poisson’s ratio used for smoothing based on the linearly elastic solid model.
verbosity
Setting this to 1 will cause smoothing residuals to be printed to the text console. The default
value of 0 suppresses this output.
dynamic-mesh?
Enables/disables the dynamic mesh solver.
events/
Enters the dynamic mesh events menu.
export-event-file
Exports dynamic mesh events to file.
import-event-file
Imports dynamic mesh event file.
steady-pseudo-time-control
Enables/disables the pseudo time step control in the graphical user interface.
transient-settings/
Enters the transient dynamic mesh settings menu. This text command is only available when you enable
dynamic mesh using the prompts of the define/dynamic-mesh/dynamic-mesh? text command.
Solver time must also be set to Transient.
allow-second-order?
Enables/disables second order transient scheme for dynamic mesh cases.
verbosity
Enables/disables transient scheme verbosity for dynamic mesh cases.
zones/
Enters the dynamic mesh zones menu.
create
Creates or edit a dynamic zone.
delete
Deletes a dynamic zone.
insert-boundary-layer
Inserts a new cell zone.
insert-interior-layer
Inserts a new layer cell zone at a specified location.
list
Lists the dynamic zones.
remove-boundary-layer
Removes a cell zone.
remove-interior-layer
Removes an interior layer cell zone.
enable-mesh-morpher-optimizer?
Enables the mesh morpher/optimizer. When the mesh morpher/optimizer is enabled, the define/mesh-
morpher-optimizer text command becomes available.
injections/
Enters the injections menu.
For a description of the items in this menu, see define/models/dpm/injections.
materials/
Enters the materials menu.
change-create
Changes the properties of a locally-stored material or create a new material.
copy
Copies a material from the database.
copy-by-formula
Copies a material from the database by formula.
data-base/
Enters the material database menu.
database-type
Sets the database type.
edit
Edits material.
list-materials
Lists all materials in the database.
list-properties
Lists the properties of a material in the database.
new
Defines new material.
save
Saves user-defined database.
delete
Deletes a material from local storage.
list-materials
Lists all locally-stored materials.
define/
list-properties
Lists the properties of a locally-stored material.
mesh-interfaces/
Enters the mesh-interfaces menu.
auto-options/
Enters the auto-options menu.
naming-option
Specifies whether or not the name of each mesh interface includes the names or IDs of the
boundary zones that constitute it. This setting only applies to mesh interfaces created with the
define/mesh-interfaces/auto-pairing-one-to-one text command.
proximity-tolerance
Sets the tolerance used when automatically grouping zones to create one-to-one mesh interfaces.
The proximity tolerance is defined relative to the edge lengths in the interface zones, and can
range from 0 to 1 (representing the minimum and maximum edge lengths, respectively).
set-default-name-prefix
Specifies the default interface name prefix used for mesh interfaces created through the
define/mesh-interfaces/auto-pairing-one-to-one text command.
auto-pairing
Automatically "pairs" some or all of the interface zones, in order to create mesh interfaces. Note that
this text command does not allow single boundary zones to be a part of multiple mesh interfaces. Not
all of the interface options are available at the time of creation: some can be enabled afterward using
the define/mesh-interfaces/edit text command; for the periodic and periodic repeats options,
you must instead create the interface using the define/mesh-interfaces/make-periodic
and define/mesh-interfaces/create text commands, respectively.
auto-pairing-one-to-one
Automatically "pairs" some or all of the wall and interface zones, in order to create mesh interfaces
that are one-to-one (that is, have a single zone assigned to each side), and that use the static option
(along with the coupled wall option, if it is a fluid-to-solid mesh interface). Note that this text command
allows single boundary zones to be a part of multiple mesh interfaces.
create
Creates a mesh interface.
delete
Deletes a mesh interface.
delete-all
Deletes all sliding-interfaces.
draw
Draws specified sliding interface zone.
edit
Edits attributes of mesh interfaces, including the interface options and (for a single interface) the name
and the list of interface zones assigned to the interface. Note that this text command cannot edit mesh
interfaces that were created using the define/mesh-interfaces/auto-pairing-one-to-
one text command.
enforce-continuity-after-bc?
Enables/disables continuity across the boundary condition interface for contour plots in postprocessing.
enforce-coupled-wall-between-solids?
Enables/disables automatic definition of solid-solid interfaces as coupled walls. By default this option
is disabled and ANSYS Fluent creates interior boundaries at solid-solid interfaces.
improve-quality
Checks the quality of all mapped interfaces. If Fluent finds any mapped interfaces that require improve-
ment it will list them and ask you if you would like to increase the tolerance to improve the interfaces.
list
Lists all mesh interfaces.
make-periodic
Makes interface zones periodic.
mapped-interface-options/
Enters the mapped-interface menu. Options are available to convert a non-conformal interface to a
mapped interface.
convert-to-mapped-interface
Converts non-conformal mesh interface to mapped mesh interfaces. Answering yes to

Convert all mesh interfaces to mapped mesh interfaces? will enforce
the mapping such that it specifies all interfaces as mapped interfaces; the mapped interfaces
are created regardless of mesh quality. Answering yes to Convert poorly matching
mesh interfaces to mapped mesh interfaces? will automate the mapping
such that all interfaces that penetrate each other are automatically defined as mapped in-
terfaces. Note that in all cases, only interfaces for which at least one side of the interface
consists of only solid zones will be converted.
solution-controls
Specifies the mapped frequency and under-relaxation factor for mapped interfaces.
tolerance
Specifies the mapped interface tolerance. After changing the tolerance, the existing mapped inter-
face will be updated.
non-conformal-interface-numerics/
Enters the non-conformal-interface-numerics menu.
change-numerics?
Provides options to improve numerics for non-conformal interfaces in some cases.
• Enforce watertight cells for fluid-solid and solid-solid inter-

faces?: Answering yes ensures cells adjacent to a non-conformal fluid-solid or solid-
solid interface are watertight when performing the coupled wall discretization.
• Use enhanced gradient computations for fluid-solid and solid-

solid interfaces?: Answering yes enables improvements to the calculation of
gradients.
define/
• Recreate non-conformal interfaces?: If you change the response to either of

the previous two questions then interfaces should be recreated.
transfer-motion-across-interfaces?
Enables/disables the automatic transfer of motion across a mesh interface when only one side is
moving as a result of user-defined or system coupling motion. You can specify the method by which
the motion is transferred: transfer-displacements (the default) interpolates nodal displacement
from the active side of the interface to the passive side, and is recommended when there are gaps
and/or penetrations in the mesh interface that must be maintained; project-nodes projects the
passive nodes onto the faces of active side, and is recommended when the active side includes signi-
ficant tangential motion (as only the normal displacement is effectively transferred in this method).
turbo-create
Creates a general turbo interface.
use-virtual-polygon-approach
Uses new virtual polygon approach for interfaces.
Important:
Note that case files created after ANSYS Fluent 6.1 will not show the virtual-polygon
option, since it is the default.
verbosity
Sets the mesh interface verbosity.
mesh-morpher-optimizer/
Enters the mesh morpher/optimizer menu in order to deform the mesh as part of a shape optimization
problem. This text command is only available when the define/enable-mesh-morpher-optimizer?
text command has been enabled.
deformation-settings/
Enters the deformation menu. This text command is only available if you have created a deformation
region using the define/mesh-morpher-optimizer/region/create or the define/mesh-
morpher-optimizer/region/define-bounding-box text command.
check-mesh
Displays a mesh check report in the console for the mesh displayed in the graphics window. The
mesh check report provides volume statistics, mesh topology and periodic boundary information,
verification of simplex counters, and verification of node position with reference to the axis for
axisymmetric cases. This text command is only available if the define/mesh-morpher-optim-
izer/optimizer? text command is disabled.
deform-mesh
Modifies the mesh and updates the mesh display in the graphics window based on the parameter
and deformation settings. This text command is only available if the define/mesh-morpher-
optimizer/optimizer? text command is disabled.
motion-settings
Enters the motion settings menu, where you can create, modify, and delete the motions applied
to the control points. This text command is only available if the define/mesh-morpher-op-
timizer/set-control-point-distribution text command is set to unstructured.
create
Creates a new motion, by specifying the parameter, type of motion (translation, rotation, or
radial motion), directional settings, name, and control points. Note that for translations, the
values you enter for the direction components are multiplied with the value of the parameter
to define the displacement applied to the control points.
delete
Deletes an existing motion.
modify
Modifies the settings for an existing motion.
read-from-file
Defines the settings for all the motions by reading an ASCII text file.
write-to-file
Writes the settings for all the motions to an ASCII text file.
read-motion-settings-from-file
Defines all of the motion settings by reading an ASCII text file. This text command is only available
if the define/mesh-morpher-optimizer/set-control-point-distribution text
command is set to regular.
reset-all-deformations
Undoes any deformations made to the mesh and updates the mesh display in the graphics window.
set-constraints
Defines the constraints on a boundary zone, in order to limit the freedom of a particular zone that
falls within the deformation region(s) during the morphing of the mesh.
set-constraints-multiple
Defines the constraints on multiple boundary zones, in order to limit the freedom of particular
zones that fall within the deformation region(s) during the morphing of the mesh.
set-parameters
Assigns translation direction components and a single parameter to a single control point in a region.
Note that the values you enter for the direction components are multiplied with the value of the
parameter to define the displacement applied to the control point. This text command is only
available if the define/mesh-morpher-optimizer/set-control-point-distribution
text command is set to regular.
set-parameters-multiple
Assigns translation direction components and multiple parameters to multiple control points in a
region. Note that the values you enter for the direction components are multiplied with the value
of the parameter to define the displacement applied to the control point. This text command is
only available if the define/mesh-morpher-optimizer/set-control-point-distri-
bution text command is set to regular.
write-motion-settings-to-file
Writes the motion settings to an ASCII text file. This text command is only available if the
define/mesh-morpher-optimizer/set-control-point-distribution text command
is set to regular.
define/
morpher-summary
Displays a summary of the mesh morpher/optimizer settings in the console. This text command is only
available if you have created a deformation region using the define/mesh-morpher-optim-
izer/region/create or the define/mesh-morpher-optimizer/region/define-
bounding-box text command.
optimizer-parameters/
Enters the optimizer menu. This text command is only available when you have created a deformation
region using the define/mesh-morpher-optimizer/region/create or the define/mesh-
morpher-optimizer/region/define-bounding-box text command and have enabled the
define/mesh-morpher-optimizer/optimizer? text command.
convergence-criteria
Defines the convergence criteria for the optimizer.
custom-calculator
Enters the custom calculator menu, in order to define the objective function as a function of output
parameters. This menu is not available when the NEWUOA optimizer is selected using the
define/mesh-morpher-optimizer/optimizer-parameters/optimizer-type text
command.
define
Defines the custom objective function that will be minimized by the optimizer.
delete
Deletes the saved custom objective function.
example-obj-fn-definitions
Prints examples of custom objective function definitions in the console.
list-output-parameters
Prints a list of the output parameters that can be used to define the custom objective function.
disable-mesh-check
Specifies whether you want to disable the general mesh check that is part of the optimization
process. This check is conducted immediately after the mesh is deformed in every design stage,
and determines whether a solution is calculated. Disabling this check allows you to use mesh repair
commands (which can be set up using the define/mesh-morpher-optimizer/optimizer-
parameters/initial-commands text command) at the start of a design stage, so that an
accurate solution can be calculated.
end-commands
Specifies the commands (text commands or command macros) that will be executed after the
solution has run and converged for a design stage. This text command is not available when the
NEWUOA optimizer is selected using the define/mesh-morpher-optimizer/optimizer-
parameters/optimizer-type text command.
initial-commands
Specifies the commands (text commands or command macros) that will be executed after the
design has been modified, but before ANSYS Fluent has started to run the calculation for that
design stage. This text command is not available when the NEWUOA optimizer is selected using
the define/mesh-morpher-optimizer/optimizer-parameters/optimizer-type
text command.
initialization
Specifies how the solution variables should be treated after the mesh is deformed, that is, whether
they should be initialized to the values defined in the Solution Initialization task page, remain
the values obtained in the previous design iteration, or be read from a data file that you specify.
iterations-per-design
Defines the maximum number of iterations ANSYS Fluent will perform for each design change.
maximum-designs
Defines the maximum number of design stages the optimizer will undergo to reach the specified
objective function.
mesh-quality-check
Specifies if orthogonal quality should be used to determine whether a solution is calculated for a
mesh, and defines the minimum orthogonal quality value allowed (values may range from 0–1,
where 0 represents the worst quality).
monitor/
Enters the monitor menu in order to plot and/or record optimization history data, that is, how the
value of the objective function varies with each design stage produced by the mesh morpher/op-
timizer. This text menu is not available when the NEWUOA optimizer is selected using the
define/mesh-morpher-optimizer/optimizer-parameters/optimizer-type text
command.
clear-opt-hist
Discards the optimization history data, including the associated files.
plot-hist
Displays an XY plot of the optimization history data generated during the last calculation. Note
that no plot will be displayed if the data was discarded using the define/mesh-morpher-
optimizer/optimizer-parameters/monitor/clear-optimization-monitor-
data text command.
plot?
Enables the plotting of the optimization history data in the graphics window.
write?
Enables the saving of the optimization history data to a file.
newuoa-initial-parameter-variation
Defines how much the parameters will be allowed to vary during the initial calculations. This text
command is only available when the NEWUOA optimizer is selected using the define/mesh-
morpher-optimizer/optimizer-parameters/optimizer-type text command.
objective-function-definition
Specifies whether the format of the objective function is a user-defined function, a Scheme source
file, or a custom function based on output parameters. The custom function is defined using the
text commands in the define/mesh-morpher-optimizer/optimizer-parameters/cus-
tom-calculator menu. The objective-function-definition text command is not
available when the NEWUOA optimizer is selected using the define/mesh-morpher-optim-
izer/optimizer-parameters/optimizer-type text command.
define/
optimize
Initiates the optimization process. This text command is only available if the define/mesh-
morpher-optimizer/optimizer? text command is enabled.
optimizer-type
Specifies which optimizer is to be used. You can select one of the six built-in optimizers (1–5 and
7), or specify that you will use Design Exploration in ANSYS Workbench (6). Note that 6 is only
available if you have launched your ANSYS Fluent session from ANSYS Workbench. For information
about how the built-in optimizers function or how to use Design Exploration, see Design Analysis
and Optimization in the User's Guide or Working With Input and Output Parameters in Workbench
in the ANSYS Fluent in Workbench User's Guide, respectively.
save-case-data-files
Sets up the automatic saving of intermediate case and data files during the optimization run, by
specifying: the frequency (in design iterations) with which file sets are saved; the maximum number
of file sets retained (after the maximum limit has been saved, the earliest file set will be overwritten
with the latest); and the root name assigned to the files (which will have the design iteration
number appended to it).
optimizer?
Enables the use of a built-in optimizer. This text command is only available if you have created a de-
formation region using the define/mesh-morpher-optimizer/region/create or the
define/mesh-morpher-optimizer/region/define-bounding-box text command.
parameter-settings/
Enters the parameters menu.
number-of-parameters
Defines the number of parameters that will be used to define the deformation.
parameter-bounds
Defines the minimum and maximum values allowed by the built-in optimizer for the parameters.
This text command is only available if the define/mesh-morpher-optimizer/optimizer?
text command is enabled.
parameter-value
Defines the value of a parameter. This value represents a magnitude that will then be used along
with other direction settings to define motions that produce an overall displacement for a given
control point. The value will specify a length in meters for translations and radial motions, and will
specify an angle in degrees for rotations; the units here will be used regardless of what units you
are using in the case. Note that you can enter a numeric value or define an input parameter (if you
have enabled the definition of input parameters using the define/parameters/enable-in-
TUI? text command). The parameter-value text command is only available in the following
situations:
• if the define/mesh-morpher-optimizer/optimizer? text command is disabled
• if the define/mesh-morpher-optimizer/optimizer? text command is enabled and

6 is selected for the optimizer type via the define/mesh-morpher-optimizer/optim-
izer-type text command
region/
Enters the region menu in order to define the regions of the domain where the mesh will be deformed
in order to optimize the shape.
control points
Enters the control points menu in order to create, modify, and/or delete control points. This text
command is only available if the define/mesh-morpher-optimizer/set-control-
point-distribution text command is set to unstructured.
create
Creates a new control point by defining the coordinates of a point within an existing deform-
ation region.
delete
Deletes existing control points.
distribute-points-on-zone
Creates an approximate number of control points on the mesh nodes of a particular boundary
zone, with a distribution that is based on the distribution of the cell faces in that zone.
modify
Modifies the coordinates of existing control points.
read-from-file
Defines all of the control points by reading an ASCII text file.
write-to-file
Writes the control point coordinates to an ASCII text file.
create
Creates a new deformation region by specifying the name, number of control points (for a regular
distribution), dimensions, origin coordinates, the components of the direction vectors, and
whether to smooth the transitions of the mesh at the region boundaries (for an unstructured dis-
tribution). The region will be a “box”, that is, a rectangle for 2D cases or a rectangular hexahedron
for 3D cases. After you have created a deformation region, additional menus will be available in
the define/mesh-morpher-optimizer menu.
define-bounding-box
Creates a new deformation region by specifying the name, the bounding zones that best represent
the extents of the deformation region, the number of control points (for a regular distribution),
and whether to smooth the transitions of the mesh at the region boundaries (for an unstructured
distribution). The region will be a “box”, that is, a rectangle for 2D cases or a rectangular hexahedron
for 3D cases. After you have created a deformation region, additional menus will be available in
the define/mesh-morpher-optimizer menu.
delete
Deletes a deformation region.
scaling-enlarge
Sets the scaling factor applied to the bounding box when you click the Enlarge button in the Re-
gions tab of the Mesh Morpher/Optimizer dialog box.
scaling-reduce
Sets the scaling factor applied to the bounding box when you click the Reduce button in the Re-
gions tab of the Mesh Morpher/Optimizer dialog box.
define/
set-control-point-distribution
Specifies whether the control point distribution is regular (that is, spread in a regular distribution
throughout the entire deformation region) or unstructured (that is, distributed at specified locations).
mixing-planes/
Enters the mixing planes menu.
create
Creates a mixing plane.
delete
Deletes a mixing plane.
list
Lists defined mixing plane(s).
set/
Sets global parameters relevant to mixing planes.
averaging-method
Sets the mixing plane profile averaging method.
under-relaxation
Sets mixing plane under-relaxation factor.
fix-pressure-level
Sets fixed pressure level using value based on define/reference-pressure-location.
conserve-swirl/
Enters the menu to set swirl conservation in mixing plane menu.
enable?
Enables/disables swirl conservation in mixing plane.
verbosity?
Enables/disables verbosity in swirl conservation calculations.
report-swirl-integration
Reports swirl integration (Torque) on inflow and outflow zones.
conserve-total-enthalpy/
Enters the menu to set total enthalpy conservation in mixing plane menu.
enable?
Enables/disables total enthalpy conservation in mixing plane.
verbosity?
Enables/disables verbosity in total-enthalpy conservation calculations.
models/
Enters the models menu to configure the solver.
acoustics/
Enters the acoustics menu.
auto-prune
Enables/disables auto prune of the receiver signal(s) during read-and-compute.
broad-band-noise?
Enables/disables the broadband noise model.
convective-effects?
Enables/disables the convective effects option.
compute-write
Computes sound pressure.
cylindrical-export?
Enables/disables the export of data in cylindrical coordinates.
display-flow-time?
Enables/disables the display of flow time during read-and-compute.
export-source-data-cgns?
Enables/disables the export of acoustic source data in CGNS format.
export-volumetric-sources?
Enables/disables the export of fluid zones.
export-volumetric-sources-cgns?
Enables/disables the export of fluid zones.
export-source-data?
Enables/disables the export of acoustic source data in ASD format during the wave equation
model run.
far-field-parameters/
Enters the menu to specify the far-field density and speed of sound. Note that this menu is currently
available only with the acoustics wave equation model.
far-field-density
Specifies the far-field density value for the acoustics wave equation model.
far-field-sound-speed
Specifies the far-field speed of sound value for the acoustics wave equation model.
ffowcs-williams?
Enables/disables the Ffowcs-Williams-and-Hawkings model.
moving-receiver?
Enables/disables the moving receiver option.
off?
Enables/disables the acoustics model.
read-compute-write
Reads acoustic source data files and computes sound pressure.
receivers
Sets acoustic receivers.
define/
sources
Sets acoustic sources.
sources-fft/
Enters the acoustic sources fast Fourier transform (FFT) menu, to compute Fourier spectra from
acoustic source data (ASD) files, create postprocessing variables for the pressure signals, and write
CGNS files of the spectrum data.
read-asd-files
Reads ASD files to perform FFT of the pressure history field.
compute-fft-fields
Computes FFT of the read pressure histories. The computed spectra replace the pressure his-
tories in memory.
clean-up-storage-area
De-allocates memory used to store the pressure histories and their Fourier spectra, as well as
any created surface variables for the visualization.
write-cgns-files
Writes surface pressure spectra in CGNS format, which can be used for one-way coupling with
ANSYS Mechanical in the frequency domain.
fft-surface-variables/
Enters the menu to create surface variables from the computed Fourier spectra for visualization.
create-constant-width-bands
Selects up to 20 constant width bands and creates surface pressures level (SPL) variables
for them.
create-octave-bands
Creates surface pressure level (SPL) variables for 17 technical octaves.
create-third-bands
Creates surface pressure level (SPL) variables for 54 technical thirds.
create-set-of-modes
Selects up to 20 individual Fourier modes and create variable pairs for them, containing
the real and the imaginary parts of the complex Fourier amplitudes.
remove-variables
Removes all variables created in this menu.
wave-equation?
Enables/disables the wave equation model.
wave-equation-options/
Enters the menu to define the acoustics wave equation model options.
basic-shapes/
Enters the menu to define the geometry of the source mask and sponge layer using the basic
shapes, represented by the cell registers of the type "Region".
add-source-mask-shape
Adds a basic shape to the definition of the source mask geometry.
add-sponge-layer-shape
Adds a basic shape to the definition of the sponge layer geometry.
list-source-mask-shapes
List basic shapes, which are currently used in the definition of the source mask geometry.
list-sponge-layer-shapes
List basic shapes, which are currently used in the definition of the sponge layer geometry.
list-region-registers
List all available cell registers of the type "Region".
remove-source-mask-shape
Remove a basic shape from the definition of the source mask geometry.
remove-sponge-layer-shape
Remove a basic shape from the definition of the sponge layer geometry.
remote-receivers-options/
Enters the menu to define remote receivers for the Kirchhoff integral model.
integration-surface
Selects the integration surface for the Kirchhoff model.
write-signals
Writes the computed receiver signals to the ASCII files.
remote-receivers?
Enables/disables the Kirchhoff integral model.
source-mask-udf
Specifies the name of a user-defined function, which defines geometry of the source mask.
sponge-layer-base-value
Specifies the base value of the artificial viscosity coefficient.
sponge-layer-factor
Specifies the factor of the artificial viscosity coefficient.
sponge-layer-udf
Specifies the name of a user-defined function, which defines geometry of the sponge layer.
time-filter-source?
Enables/disables a time filter for the sound source.
write-acoustic-signals
Writes on-the-fly sound pressure.
write-centroid-info
Writes centroid info.
addon-module
Loads addon module.
define/
axisymmetric?
Specifies whether or not the domain is axisymmetric.
cht
Enters the cht (conjugate heat transfer) menu.
implicit-coupling?
Enables the implicit mapping scheme for any fluid-solid pair with a mapped mesh interface (only
required for cases set up in version 19.2 or earlier).
crevice-model?
Enables/disables the crevice model.
crevice-model-controls/
Enters the crevice model controls menu.
dpm/
Enters the dispersed phase model menu.
clear-particles-from-domain
Removes/keeps all particles currently in the domain.
collisions/
Enters the DEM collisions menu.
collision-mesh
Input for the collision mesh.
collision-pair-settings/
Supplies settings for collisions to a pair of collision partners. You will be prompted to specify
the Impact collision partner and the Target collision partner.
contact-force-normal
Sets the normal contact force law for this pair of collision partners.
contact-force-tangential
Sets the tangential contact force law for this pair of collision partners.
list-pair-settings
Lists the current settings for this pair of collision partners.
collision-partners/
Manages collision partners.
copy
Copies a collision partner.
create
Creates a collision partner.
delete
Deletes a collision partner.
list
Lists all known collision partners.
rename
Renames a collision partner.
dem-collisions?
Enables/disables the DEM collision model.
list-all-pair-settings
For each pair of collision partners, lists the collision laws and their parameters.
max-particle-velocity
Sets the maximum particle velocity that may arise from collisions.
erosion-dynamic-mesh/
Enters the menu to enable/configure/run the erosion-dynamic mesh interaction.
enable-erosion-dynamic-mesh-coupling?
Enables mesh deformation due to wall erosion.
general-parameters/
Enters the menu for setting erosion coupling with dynamic mesh.
dynamic-mesh-settings
Sets parameters for dynamic mesh calculations.
erosion-settings
Sets parameters for erosion calculations.
participating-walls
Specifies all participating walls.
run-parameters/
Manages erosion-dynamic mesh run settings.
autosave-files
Sets the iteration increment and filename to save data files.
autosave-graphics
Sets the iteration increment to save graphics files.
flow-simulation-control
Sets the number of iterations per flow simulation step.
mesh-motion-time-step
Sets the mesh motion time stepping parameters and method.
simulation-termination
Sets the total time of erosion.
run-simulation
Performs a coupled erosion-dynamic mesh simulation.
injections/
Enters the injections menu.
define/
create-injection
Creates an injection.
delete-injection
Deletes an injection.
injection-properties/
Enters the menu to set or display properties for one or more injections.
file/
Enters the menu to specify file injection settings.
filename
Specifies the name for the injection file.
repeat-interval-in-file
Puts the unsteady file injection into a time-periodic mode. For more information, see
User Input for File Injections in the Fluent User's Guide.
start-flow-time-in-file
Specifies the flow-time in the unsteady injection file from which ANSYS Fluent starts
reading the injection file. For more information, see User Input for File Injections in the
Fluent User's Guide.
list/
Enters the menu to display the current properties for one or more injections.
list-picked-injections
Lists the injections that have been selected for display using pick-injections-
to-list.
list-picked-properties-to-list
Lists the properties that have been selected for display using pick-properties-
to-list.
list-property-values
Lists the settings for the properties selected with pick-properties-to-list.
This text command is only available when a single injection has been selected with
pick-injections-to-list. This option is available if at least two injections have
been selected.
list-uniform-values
Lists the settings for properties selected with pick-properties-to-list that
have uniform values for all of the injections selected with pick-injections-to-
list. This option is available if at least two injections have been selected.
list-values-per-injection
For each injection selected with pick-injections-to-list, lists the values for
properties selected with pick-properties-to-list. This option is available if at
least two injections ave been selected.
list-values-per-property
For each property selected with pick-properties-to-list, lists the values for
the injections selected with pick-injections-to-list. This option is available
if at least two injections have been selected.
pick-injections-to-list
Selects the injection or injections for which property values will be displayed. The use
of asterisks (*) as wildcards is supported.
pick-properties-to-list
Selects the property or properties for which values will be displayed. The use of asterisks
(*) as wildcards is supported.
set/
Enters the menu to set physical models such as drag and breakup for one or more injections.
list-picked-injections
Lists the injections selected for setting with pick-injections-to-set.
location/
Enters the injection location settings menu. This command is only available when you
select the injection(s) using the prompts of the define/models/dpm/injec-
tions/properties/set/pick-injections-to-set text command.
spatial-staggering/
Enters the injection spatial-staggering settings menu.
stagger-atomizer-positions?
Enables spatial staggering of the atomizer injection. This option is available
only if at least one atomizer injection has been selected using define/injec-
tions/properties/set/pick-injections-to-set.
stagger-radius
Specifies the stagger radius of the region from which particles are released.
This option is available only if at least one standard injection has been selected
using define/injections/properties/set/pick-injections-
to-set.
stagger-std-inj-positions?
Enables injection-specific spatial staggering of the particles. This option is
available only if at least one standard injection has been selected using
define/injections/properties/set/pick-injections-to-set.
physical-models
Enters the menu to set physical models such as drag and breakup for the selected in-
jections. This command is only available when you select the injection(s) using the
prompts of the define/models/dpm/injections/properties/set/pick-
injections-to-set text command.
brownian-motion
Enables Brownian motion effects for the currently selected injection(s).
define/
drag-parameters
Sets the drag law and corresponding parameters for the currently selected injec-
tion(s).
particle-rotation
Enters the menu to set-up rotation related models.
enable-rotation
Enables/disables solution of ODE for the angular acceleration of particles.
magnus-lift-law
Sets the law for the rotational lift coefficient used in the formulation of Magnus
lift force.
rotational-drag-law
Sets the law for the rotational drag coefficient.
rough-wall-model
Enables/disables the rough wall model.
spray-secondary-breakup
Enters the menu for setting the breakup model and parameters for the currently
selected injection(s). Available commands are as those described under
define/models/dpm/spray-model/ with the addition of the following.
pick-injections-to-set
Selects the injection or injections for which properties will be set. The use of asterisks
(*) as wildcards is supported.
list-particles
Lists particle streams in an injection.
modify-all-injections
Enters the menu to set properties for all injections.
injection-type
Defines injection type.
number-of-tries
Sets the number of stochastic tries.
random-eddy-lifetime?
Turns enable/disable a random eddy lifetime.
stochastic-tracking?
Turns enable/disable stochastic tracking.
time-scale-constant
Sets the time scale constant.
rename-injection
Renames an injection.
set-injection-properties
Sets injection properties.
Important:
Drag and breakup model parameters for each injection are set instead in
/define/models/dpm/injections/injection-properties.
interaction/
Sets parameters for coupled discrete phase calculations.
coupled-calculations?
Selects whether or not to couple continuous and discrete phase calculations.
implicit-momentum-coupling?
Enables/disables implicit treatment for the DPM momentum source terms.
implicit-source-term-coupling?
Enables/disables implicit treatment for all DPM source terms.
linear-growth-of-dpm-source-term?
Enables/disables the linear ramping up of the DPM source terms at every DPM iteration.
linearized-dpm-source-terms?
Enables/disables linearization of source terms for the discrete phase.
dpm-iteration-interval
Sets the frequency with which the particle trajectory calculations are introduced.
reset-sources-at-timestep?
Enables/disables flush of DPM source terms at beginning of every time step.
underrelaxation-factor
Sets the under-relaxation factor for the discrete phase sources.
update-dpm-sources-every-flow-iteration?
Enables/disables the update of DPM source terms every flow iteration (if this option is not en-
abled, the terms will be updated every DPM iteration).
numerics/
Enters the numerics menu to set numerical solution parameters.
automated-scheme-selection?
Enables/disables the adaptation of integration step length based on a maximum error.
average-DDPM-variables?
Enables/disables mesh node averaging of DDPM quantities.
average-each-step?
Enables/disables mesh node averaging during integration time step.
average-kernel
Specifies the averaging kernel to use for mesh node averaging.
define/
average-source-terms?
Enables/disables mesh node averaging of DPM source terms.
coupled-heat-mass-update
Enables/disables coupled heat and mass update.
drag-law
Sets the drag law.
enable-node-based-averaging?
Enables/disables mesh node averaging of DPM quantities.
error-control?
Adapts integration step length based on a maximum error.
gaussian-factor
Specifies the Gaussian constant when using the gaussian kernel for mesh node averaging.
high-resolution-tracking/
Enters the high resolution tracking menu. See Tracking Settings for the Discrete Phase Model
in the Fluent User's Guide for more information about these options.
check-subtet-validity?
When enabled, checks the validity of a subtet when the particle first enters it. If the subtet
is found to be degenerate, the tracking algorithm modifies to accommodate it.
enable-automatic-intersection-tolerance?
Enables/disables the automatic calculation of intersection tolerance. By default, the tolerance
used in intersection calculations is scaled by the residence time of the particle in the cell
to improve robustness. For most cases, the scaled tolerance is sufficient to identify all inter-
sections of the particle trajectory and the subtet faces. You can set the intersection tolerance
manually using the set-subtet-intersection-tolerance text command.
enable-high-resolution-tracking?
Enables/disables high resolution tracking.
interpolate-flow-solution-gradients?
When enabled, flow solution gradients are interpolated to the particle position. This can
be useful when using physical models that depend on these gradients (for example, the
thermophoretic force, pressure-gradient force, or virtual mass force). Interpolating the
gradients also improves the accuracy and robustness of the trapezoidal numerics scheme,
which is the default method for pathlines.
project-wall-film-particles-to-film?
Enables/disables projecting existing particles to Lagrangian wall film to track using high-
resolution tracking.
When reading in a data file that contains wall film particles previously tracked with
the existing ANSYS Fluent tracking method, you need to either clear the particles
from the domain or project their positions to the wall film surface using the pro-
ject-wall-film-particles-to-film? text command prior to using the
high-resolution tracking method. After tracking the particles for one timestep, this
option can be disabled to improve performance.
set-subtet-intersection-tolerance
Specifies the tolerance used in intersection calculations. This tolerance will be scaled by
the characteristic cell crossing time of the particle if the enable-automatic-inter-
section-tolerance? text command is enabled. If that option is disabled, the specified
tolerance will be used without scaling. This may be useful in cases when there are incom-
plete particles or particles leave the domain. The default intersection tolerance is 10-5.
tracking-statistics
Controls the format of the one-line tracking statistics to be printed after every DPM tracking
pass. A value of 0 (the default) prints only fates with non-zero values. A value of 1 prints
all fates, including fates with zero values.
use-quad-face-centroid?
Enables/disables using quad face centroids when creating subtets. This option changes
the way hexahedral cells are decomposed to avoid creating degenerate subtets.
minimum-liquid-fraction
A droplet evaporates completely when the remaining mass is below this fraction of the initial
droplet mass.
tracking-parameters
Sets parameters for the (initial) tracking step length.
tracking-scheme
Specifies a tracking scheme.
underrelax-film-height
Sets the under-relaxation factor for the film height calculation. The recommended values range
between 0.5 (default) and 0.9.
vaporization-limiting-factors
Sets the Vaporization Fractional Change Limits.
options/
Enters the options menu to set optional models.
allow-supercritical-pressure-vaporization?
Enforces the switching from vaporization to boiling even if the boiling point is not calculated
from the vapor pressure data. If the pressure in your model is above critical you must retain
the default setting (yes). This options is available only if when Pressure Dependent Boiling
is enabled in the Physical Models tab of the Discrete Phase Models dialog box. For more
details, see Enabling Pressure Dependent Boiling in the Fluent User's Guide.
brownian-motion
Enables/disables Brownian motion of particles.
current-positions-in-sample-file-format?
When enabled, generates a file containing particle current positions (step-by-step history report
for unsteady tracking) in the sampling file format.
enable-contour-plots
Enables computation of mean and/or RMS values of additional discrete phase variables for
postprocessing.
define/
ensemble-average
Ensembles average cloud properties.
erosion-accretion
Enables/disables erosion/accretion.
init-erosion-accretion-rate
Initializes the erosion/accretion rates with zero.
maximum-udf-species
Specifies the maximum number of species that will be accessible from discrete phase model
UDFs. Only species with indices up to this value are accessible in discrete phase model UDFs.
particle-radiation
Enables/disables particle radiation.
pressure-gradient-force
Enables/disables inclusion of pressure gradient effects in the particle force balance.
remove-wall-film-temperature-limiter?
Answering yes at the prompt removes the wall temperature limiter for Lagrangian wall-film
walls. If you enter no (default), two additional prompts will appear in the console allowing you
to define the temperature difference above the boiling point and to enable/disable the reporting
of the Leidenfrost temperature on the wall faces.
scr-urea-deposition-risk-analysis/
Enters the menu for setting up the risk for solids deposit formation for the Selective Catalytic
Reduction (SCR) process. For more information, see Assessing the Risk for Solids Deposit
Formation During Selective Catalytic Reduction Process in the Fluent User's Guide.
cryst-depo-weight
Sets the weighting factor for crystallization reactions risk.
cryst-max-temp
Sets maximum temperature for urea crystallization.
cryst-min-mass-fract
Sets the minimum urea mass fraction for crystallization.
cryst-min-temp
Sets minimum temperature for urea crystallization.
enable?
Enables/disables the SCR urea deposition risk analysis.
heat-flux-based-risk-weight
Sets the weighting factor for heat flux-based component within hydrodynamic risk.
hydrodynamic-risk-weight
Sets the weighting factor for all hydrodynamic deposition risk.
seco-rx-max-temp
Sets maximum temperature for secondary reactions.
seco-rx-min-hnco
Sets the minimum HNCO mass fraction in the gas phase above the film for secondary reac-
tions.
seco-rx-min-temp
Sets minimum temperature for secondary reactions.
velocity-based-risk-weight
Sets the weighting factor for velocity-based component within hydrodynamic risk.
wall-face-zones
Lists the selected wall zones and allows you to modify the selection list.
stagger-spatially-atomizer-injections?
Enables/disables spatial staggering for atomizer and solid-cone injections.
stagger-spatially-standard-injections?
Enables/disables spatial staggering for standard (non-atomizer and non-solid-cone) injections.
stagger-temporally?
Enables/disables temporal staggering.
staggering-factor
Controls the percentage of every particle's initial time step that will be sampled.
saffman-lift-force
Enables/disables Saffman lift force.
stagger-radius
Specifies the region over which to spatially stagger particles when particle-staggering is enabled
for non-atomizer injections.
step-report-sig-figures
Sets significant figures in the step-by-step report.
thermophoretic-force
Enables/disables thermophoretic force.
track-in-absolute-frame
Enables/disables tracking in absolute frame.
treat-multicomponent-saturation-temperature-failure?
Enables/disables dumping multicomponent particle mass into the continuous phase if the
saturation temperature calculation fails.
two-way-coupling
Enables/disables calculation of DPM sources in TKE equation.
uniform-mass-distribution-for-injections?
Specifies a uniform distribution of mass over the cross-section of solid cone and atomizer in-
jections. This can become important when the mesh is smaller than the diameter (or another
characteristic size) of the injection.
define/
use-absolute-pressure-for-vaporization?
Determines whether the absolute pressure or constant operating pressure (specified in
define/operating-conditions/operating-pressure) will be used in vaporization
rates calculations.
vaporization-heat-transfer-averaging
Enables averaging of the Spalding heat transfer term for the convection/diffusion-controlled
model.
vaporization-options
Sets Vaporization options.
virtual-mass-force
Enables/disables inclusion of the virtual mass force in the particle force balance.
parallel/
Enters the parallel menu to set parameters for parallel DPM calculations.
enable-workpile?
Turns on/off particle workpile algorithm. This option is only available when the
define/models/dpm/parallel/use-shared-memory option is selected.
expert/
Enters the menu for expert DPM parallel text commands.
partition-method-hybrid-2domain
Enables/disables a partitioning method that is more granular and can yield faster calculations
(especially for cases that are running on a low to moderate number of processors). This
partitioning method is only applied when you use the DPM domain for the hybrid parallel
DPM tracking mode (that is, when you have enabled the define/models/dpm/paral-
lel/hybrid-2domain? text command).
hybrid-2domain?
Enables/disables the use of a second domain for DPM particle tracking.
n-threads
Sets the number of processors to use for DPM. This option is only available when the
define/models/dpm/parallel/enable-workpile? option is enabled.
report
Prints particle workpile statistics. This option is only available when the define/mod-
els/dpm/parallel/enable-workpile? option is enabled.
use-hybrid
Specifies that the calculations are performed using multicore cluster computing or shared-
memory machines. This option works in conjunction with openmpi for a dynamic load balancing
without migration of cells.
use-message-passing
Specifies that the calculations are performed using cluster computing or shared-memory ma-
chines. With this option, the compute node processes themselves perform the particle work
on their local partitions and particle migration to other compute nodes is implemented using
message passing primitives.
use-shared-memory
Specifies that the calculations are performed on shared-memory multiprocessor machines.
splash-options
Enters the splash option menu.
orourke-splash-fraction
Enables/disables the O’Rourke formulation (default for the Lagrangian Wall Film (LWF) model).
If the O’Rourke formulation is disabled, the Stanton formulation (default for the Eulerian Wall
Film (EWF) model) is used in a simulation.
splash-pdf-limiting
Sets the splash pdf limiting method. Available methods are: the splash pdf tail limiting (default
for the LWF model) and the splash pdf peak limiting (default for the EWF model). For the splash
pdf peak limiting, you will be prompted to specify the peak limiting value.
spray-model/
Enters the spray model menu. This command is available only if the breakup model enabled
globally.
breakup-model-summary
Current spray model settings.
consider-children-in-the-same-tracking-step?
Enables/disables collecting and tracking new generated child droplets within the same time
step.
droplet-coalescence?
Enables/disables droplet coalescence when using the stochastic collision model. This option
is available if all injections have been selected and the DEM model is disabled.
droplet-collision?
Enables/disables droplet collision model.
enable-breakup?
Enables/disables breakup globally, but does not alter injection settings other than enable/dis-
able.
khrt-model
Sets the KHRT breakup model.
madabhushi-model
Sets the Madabhushi breakup model.
no-breakup
Disables the currently enabled breakup model. This option is available only if the breakup
model is enabled globally and for the selected injections, and not all injections have been se-
lected.
set-breakup
Enables/disables breakup model globally and uniformly specifies injection breakup parameters.
ssd-model
Sets the SSD breakup model.
define/
tab-model
Sets the TAB breakup model.
tab-number-of-breakup-parcels
Sets the number of parcels to break up a droplet in the TAB model.
tab-randomize-breakup-parcel-diameter?
Enables sampling of diameter for each TAB breakup parcel from a Rosin-Rammler distribution
using a random number.
wave-allow-rayleigh-growth?
Allows treatment of the Rayleigh regime, in which a cylindrical liquid jet breaks into droplets
of larger diameter. This option is available only if the WAVE model is enabled.
wave-mass-cutoff
Sets the minimum percentage of parent parcel mass shed before new parcel creation. This
option is available only if the WAVE model is enabled.
wave-model
Sets the WAVE breakup model.
wave-spray-angle-constant
Sets the spray-angle constant to compute orthogonal velocity components of child droplets
after breakup. This option is available only if the WAVE model is enabled.
stripping-options
Enters the stripping options menu.
diameter-coefficient
Sets the diameter coefficient ( in Equation 22.20 in the Theory Guide)
mass-coefficient
Sets the mass coefficient ( in Equation 22.21 in the Theory Guide)
unsteady-tracking
Enables/disables unsteady particle tracking.
user-defined
Sets DPM user-defined functions.
potential-and-li-ion-battery?
Enables/disables the electric-potential model.
energy?
Enables/disables the energy model.
eulerian-wallfilm/
Enters the Eulerian wall film model menu.
coupled-solution/
Enters the Coupled-Solution menu.
enable-coupled-solution?
Enables/disables the coupled solution method.
enable-curvature-smoothing?
Enables/disables the film curvature smoothing option and sets the smoothing parameters.
enable-wallfilm-model?
Enables/disables Eulerian Wall Film Model.
initialize-wallfilm-model
Initializes Eulerian Wall Film Model.
solve-wallfilm-equation?
Activates Eulerian Wall Film Equations.
model-options
Sets Eulerian Wall Film Model Options.
film-material
Sets Film Material and Properties.
solution-options
Sets Eulerian Wall Film Model Solution Options.
frozen-flux?
Enables/disables frozen flux formulation for transient flows.
heat-exchanger/
Enters the heat exchanger menu.
dual-cell-model/
Enters the dual cell model menu.
add-heat-exchanger
Adds heat-exchanger.
alternative-formulation?
Enables/disables alternative formulation for heat transfer calculations.
delete-heat-exchanger
Deletes heat-exchanger.
heat-exchanger?
Enables/disables the dual cell heat-exchanger model.
modify-heat-exchanger
Modifies heat-exchanger.
plot-NTU
Plots NTU vs. primary mass flow rate for each auxiliary mass flow rate.
write-NTU
Writes NTU vs. primary mass flow rate for each auxiliary mass flow rate.
macro-model/
Enters the heat macro-model menu.
define/
delete-heat-exchanger-group
Deletes heat-exchanger group.
heat-exchanger?
Enables/disables heat-exchanger model.
heat-exchanger-group
Defines heat-exchanger group.
heat-exchanger-macro-report
Reports the computed values of heat rejection, outlet temperature, and inlet temperature for
the macroscopic cells (macros) in a heat exchanger.
heat-exchanger-model
Defines heat-exchanger core model.
heat-exchanger-report
Reports the computed values of total heat rejection, outlet temperature, and inlet temperature
for a specified heat-exchanger core.
heat-exchanger-zone
Specifies the zone that represents the heat exchanger, the dimensions of the heat exchanger,
the macro grid, and the coolant direction and properties.
plot-NTU
Plots NTU vs. primary mass flow rate for each auxiliary mass flow rate.
write-NTU
Writes NTU vs. primary mass flow rate for each auxiliary mass flow rate.
multiphase/
Enters the multiphase model menu.
body-force-formulation
Specifies body force formulation.
boiling-model-options
Specifies the boiling model options. You can choose the RPI boiling model, Non-equilib-
rium boiling, or Critical heat flux.
coupled-level-set
Enables coupled level set interface tracking method.
eulerian-parameters
Specifies Eulerian parameters.
expert-options
Specifies the volume fraction sub-time step calculation method and whether to solve vof every it-
eration.
interface-modeling-options
Specifies interface modeling options.
mixture-parameters
Specifies mixture parameters.
model
Specifies multiphase model.
number-of-phases
Specifies the number of phases.
regime-transition-modeling
enables the Algebraic Interfacial Area Density (AIAD) model and sets the AIAD secondary continuous
phase and the secondary entrained phase. Entering 0 as a phase ID cancels any previous phase
selection. Note that you must define the phases in your simulation using the define/phases/
text command prior to using the regime-transition-modeling text command. This option
is available only with the Eulerian multiphase model.
vof-sub-models
Enables the Open Channel sub-model and/or the Open Channel Wave Boundary Condition sub-
model.
volume-fraction-parameters
Specifies volume fraction parameters.
wet-steam/
Enters the wet steam model menu.
compile-user-defined-wetsteam-functions
Compiles user-defined wet steam library.
enable?
Enables/disables the wet steam model.
load-unload-user-defined-wetsteam-library
Loads or unloads user-defined wet steam library.
set/
Enters the set menu for setting wet steam model options.
max-liquid-mass-fraction
Sets the maximum limit on the condensed liquid-phase mass-fraction to prevent divergence.
noniterative-time-advance?
Enables/disables noniterative time advancement scheme.
nox?
Enables/disables the NOx model.
nox-parameters/
Enters the NOx parameters menu.
inlet-diffusion?
Enables/disables inclusion of diffusion at inlets.
nox-chemistry
Selects NOx chemistry model.
nox-expert
Selects additional NOx equations.
define/
nox-turbulence-interaction
Sets NOx turbulence interaction model.
population-balance/
Enters the population balance models menu.
include expansion?
Allows you to account for bubble expansion due to large changes in hydrostatic pressure in com-
pressible flows. This option is available with the inhomogeneous discrete method.
model
Allows you to select the population balance model and set its parameters.
phenomena/
Enters the phenomena menu for population balance.
aggregation
Sets the aggregation kernel.
aggregation-factor
Specifies a factor that controls the intensity of the selected aggregation kernel.
breakage
Sets the breakage kernel.
breakage-factor
Specifies a factor that controls the intensity of the selected breakage kernel.
growth
Specifies the growth rate.
nucleation
Specifies the nucleation rate.
radiation/
Enters the radiation models menu.
apply-full-solar-irradiation?
Enables/disables the application of the complete solar load to the first wavelength band only, re-
verting to the pre-2019 R1 behavior of the Solar Load and Discrete Ordinates models.
blending-factor
Sets numeric option for Discrete Ordinate model. Make sure that Second Order Upwind is selected
for the Discrete Ordinates spatial discretization for the blending-factor option to appear in
the text command list.
discrete-ordinates?
Enables/disables discrete ordinates radiation model.
discrete-transfer?
Enables/disables discrete transfer radiation model.
do-acceleration?
Enables/disables the acceleration of the discrete ordinates (DO) radiation model calculations. Note
that this text command is only available when running on Linux in parallel.
do-coupling?
Enables/disables DO/energy coupling.
solar-irradiation?
Enables/disables the solar irradiation model.
dtrm-parameters/
Enters the dtrm parameters menu.
check-ray-file
Reads DTRM rays file.
controls
Sets dtrm solution controls.
make-globs
Makes globs (coarser mesh) for radiation.
ray-trace
Creates DTRM rays for radiation.
fast-second-order-discrete-ordinate?
Enables/disables the fast-second-order option for Discrete Ordinate Model.
mc-model-parameters
Specifies Monte Carlo model parameters. This text command is available only when the Monte
Carlo model is enabled.
mc-under-relaxation
Sets the under-relaxation factor for Monte Carlo radiation sources used in the energy equation.
method-partially-specular-wall
Sets the method for partially specular wall with discrete ordinate model.
montecarlo?
Enables/disables the Monte Carlo radiation model.
non-gray-model-parameters
Sets parameters for non-gray model.
p1?
Enables/disables P1 radiation model.
radiation-iteration-parameters
Sets iteration parameters for radiation models.
radiation-model-parameters
Sets parameters for radiation models.
rosseland?
Enables/disables Rosseland radiation model.
s2s?
Enables/disables S2S radiation model.
define/
s2s-parameters/
Enters the S2S parameters menu.
compute-fpsc-values
Computes only fpsc values based on current settings
compute-vf-only
Computes/writes view factors only.
compute-write-vf
Computes/writes surface clusters and view factors for S2S radiation model.
non-participating-boundary-zones-temperature
Sets temperature for the non-participating boundary zones.
print-thread-clusters
Prints the following for all boundary threads: thread-id, number of faces, faces per surface
cluster, and the number of surface clusters.
print-zonewise-radiation
Prints the zonewise incoming radiation, viewfactors, and average temperature.
read-vf-file
Reads S2S file.
set-global-faces-per-surface-cluster
Sets global value of faces per surface cluster for all boundary zones.
set-vf-parameters
Sets the parameters needed for the viewfactor calculations.
split-angle
Sets split angle for the clustering algorithm.
use-new-cluster-algorithm
Uses the new surface clustering algorithm.
use-old-cluster-algorithm
Uses the old surface clustering algorithm.
solar?
Enables/disables solar model.
solar-calculator
Calculates sun direction and intensity.
solar-parameters/
Enters the solar parameters menu.
autoread-solar-data
Sets autoread solar data parameters.
autosave-solar-data
Sets autosave solar data parameters.
ground-reflectivity
Sets ground reflectivity parameters.
illumination-parameters
Sets illumination parameters.
iteration-parameters
Sets update parameters.
quad-tree-parameters
Sets quad-tree refinement parameters.
scattering-fraction
Sets scattering fraction parameters.
solar-thread-control
Sets the number of threads to run the solar flux calculation. This item appears only when running
in parallel with nodes located on a separate machine from the one running the host process
and Solar Ray Tracing is enabled.
sol-adjacent-fluidcells
Sets solar load on for adjacent fluid cells.
sol-camera-pos
Sets camera position based on sun direction vector.
sol-on-demand
Sets solar load on demand.
sun-direction-vector
Sets sun direction vector.
use-direction-from-sol-calc
Sets direction computed from solar calculator.
solution-method-for-do-coupling
Enables/disables the solution method for DO/energy coupling.
target-cells-per-volume-cluster
Sets the amount of coarsening of the radiation mesh for the Monte Carlo radiation model. A
number greater than one implies coarsening, whereas equal to one implies no coarsening.
wsggm-cell-based
Enables/disables WSGGM cell based method. Note that when enabled, the wsggm-cell-based
option will become available in the Absorption Coefficient drop-down list in the Create/Edit
Materials dialog box.
shell-conduction/
Enters the shell conduction models menu.
enhanced-encapsulation?
Enables/disables an enhanced routine for the encapsulation of coupled walls during mesh parti-
tioning that is enabled by default when shell conduction and/or the surface to surface (S2S) radiation
model is used.
define/
multi-layer-shell?
Enables/disables the ability to define multi-layer shell conduction for walls. Note that the warped-
face gradient correction (WFGC) is not supported when multi-layer shells are disabled.
read-csv
Defines the shell conduction settings by reading a CSV file.
save-shell-zones?
Enables the saving of shell zones to case files.
settings
Enables shell conduction and defines the settings for any wall or group of walls by manually entering
the number and properties of the layers.
write-csv
Writes your saved shell conduction settings to a CSV file.
solidification-melting?
Enables/disables the solidification and melting model.
solver/
Enters the menu to select the solver.
density-based-explicit
Enables/disables the density-based-explicit solver.
density-based-implicit
Enables/disables the density-based-implicit solver.
pressure-based
Enables/disables the pressure-based solver.
soot?
Enables/disables the soot model.
soot-parameters/
Enters the soot parameters menu.
inlet-diffusion?
modify-schmidt-number?
Changes the turbulent Schmidt number for soot/nuclei equations.
soot-model-parameters
Selects soot model parameters.
soot-process-parameters
Selects soot process parameters.
soot-radiation-interaction
Enables/disables the soot-radiation interaction model.
soot-turbulence-interaction
Sets soot-turbulence interaction model.
sox?
Enables/disables the SOx model.
sox-parameters/
Enters the SOx parameters menu.
inlet-diffusion?
s-atom-balance?
Enables/disables S-atom mass balance calculation.
sox-chemistry
Selects the SOx chemistry model.
sox-turbulence-interaction
Sets the SOx /turbulence interaction model.
species/
Enters the species models menu.
CHEMKIN-CFD?
Enables/disables the ANSYS CHEMKIN-CFD solver.
CHEMKIN-CFD-parameters/
Enters the expert CHEMKIN-CFD parameters menu.
add-cell-monitor
Monitors cell for debug output.
advanced-options
Sets advanced parameter options.
basic-options
Sets basic parameter options.
delete-cell-monitors
Deletes cell monitors.
list-cell-monitors
Lists cell monitors.
clear-isat-table
Clears ISAT table.
coal-calculator
Sets up coal modeling inputs.
combustion-numerics
Applies optimal solver settings automatically to provide a faster solution time. This command is
available only for transient non-premixed and partially premixed combustion models.
decoupled-detailed-chemistry?
Enables/disables the Decoupled Detailed Chemistry model.
define/
diffusion-energy-source?
Enables/disables diffusion energy source.
electro-chemical-surface-reactions?
Enables/disables electrochemical surface reactions.
epdf-energy?
Enables/disables EPDF energy option.
flamelet-expert
Sets flamelet expert parameters.
full-tabulation?
Enables/disables building of a full 2-mixture fraction table
heat-of-surface-reactions?
Enables/disables heat of surface reactions.
ignition-model?
Enables/disables the ignition model.
ignition-model-controls
Sets ignition model parameters.
import-flamelet-for-restart
Imports Flamelet File for Restart.
inert-transport-controls
Sets inert transport model parameters.
inert-transport-model?
Enables/disables the inert transport model.
inlet-diffusion?
integration-parameters
Sets chemistry ODE integrator parameters. Enables/disables stiff chemistry acceleration methods
and set their parameters.
init-unsteady-flamelet-prob
Initializes Unsteady Flamelet Probability.
liquid-energy-diffusion?
Enables/disables energy diffusion for liquid regime.
liquid-micro-mixing?
Enables/disables liquid micro mixing.
mass-deposition-source?
Enables/disables mass deposition source due to surface reactions.
mixing-model
Sets PDF Transport mixing model.
multicomponent-diffusion?
Enables/disables multicomponent diffusion.
non-premixed-combustion?
Enables/disables non-premixed combustion model.
non-premixed-combustion-expert
Sets PDF expert parameters.
non-premixed-combustion-parameters
Sets PDF parameters.
off?
Enables/disables solution of species models.
partially-premixed-combustion?
Enables/disables partially premixed combustion model.
partially-premixed-combustion-expert
Sets PDF expert parameters.
partially-premixed-combustion-parameters
Sets PDF parameters.
partially-premixed-properties
Sets/changes partially-premixed mixture properties. This command is only available when par-
tially-premixed-combustion? is enabled.
re-cacl-par-premix-props
Re-calculates partially-premixed properties. This command is only available when partially-
premixed-combustion? is enabled.
particle-surface-reactions?
Enables/disables particle surface reactions.
pdf-transport?
Enables/disables the composition PDF transport combustion model.
pdf-transport-expert?
Enables/disables PDF Transport expert user.
premixed-model
Sets premixed combustion model.
premixed-combustion?
Enables/disables premixed combustion model.
reaction-diffusion-balance?
Enables/disables reaction diffusion balance at reacting surface for surface reactions.
reacting-channel-model?
Enables/disables the Reacting Channel Model.
reacting-channel-model-options
Sets Reacting Channel Model parameters.
define/
reactor-network-model?
Enables/disables the Reactor Network Model.
relax-to-equil?
Enables/disables the Relaxation to Chemical Equilibrium model.
save-gradients?
Enables/disables storage of species mass fraction gradients.
set-premixed-combustion
Sets premixed combustion parameters.
set-turb-chem-interaction
Sets EDC model constants.
spark-model
Switches between the R15 and R14.5 spark models and sets spark model parameters.
species-migration?
Includes species migration in electric field. This command is available only when the electrochem-
ical surface reactions are enabled.
species-transport-expert
Sets the convergence acceleration expert parameters. This command is only available when the
species transport model is enabled.
use convergence acceleration method?

Answering yes at the prompt, uses a combination of different convergence acceleration
techniques. If you enter no (default), additional options will be displayed in the console.
Use species clipping?

Enables/disables the explicit clipping of species between 0 and 1.
Linearize higher order convection sources?

Enables/disables linearization of higher order convection sources.
Linearize secondary diffusion sources?

Enables/disables linearization of species secondary diffusion sources.
Enable mesh quality based first-second order species blending?

Enables/disables skewness-based blending of first and second order convection.
Minimum cell quality threshold for blending

Specifies the minimum cell orthogonal quality for blending.
species-transport?
Enables/disables the species transport model.
stiff-chemistry?
Enables/disables stiff chemistry option.
surf-reaction-aggressiveness-factor?
Sets the surface reaction aggressiveness factor.
surf-reaction-netm-params
Sets the surface reaction parameters for the Non-Equilibrium Thermal Model.
thermal-diffusion?
Enables/disables thermal diffusion.
thickened-flame-model?
Enables/disables the Relaxation to Chemical Equilibrium model
volumetric-reactions?
Enables/disables volumetric reactions.
wall-surface-reactions?
Enables/disables wall surface reactions.
steady?
Enables/disables the steady solution model.
structure
Enters the structure model menu.
controls
Enters the structure controls menu.
amg-stabilization
Sets the algebraic multigrid (AMG) stabilization method for the structural model calculations.
max-iter
Sets the maximum number of iterations for the structural model calculations.
numerical-damping-factor?
Sets the damping factor for the structural model (that is, the amplitude decay factor in
Equation 21.16 in the Theory Guide).
expert
Enters the structure expert menu.
explicit-fsi-force?
Enables/disables an explicit fluid-structure interaction force.
include-pop-in-fsi-force?
Enables/disables the inclusion of operating pressure into the fluid-structure interaction force.
include-viscous-fsi-force?
Enables/disables the inclusion of a viscous fluid-structure interaction force.
linear-elasticity?
Enables the linear elasticity model.
structure-off?
Disables the structural model.
swirl?
Enables/disables axisymmetric swirl velocity.
define/
system-coupling-settings/
Enters the system coupling menu.
use-face-or-element-based-data-transfer?
Answering yes at the prompt enables Fluent to use element data for mapping surface conservative
quantities such as surface forces and heat flows.
unsteady-1st-order?
Selects the first-order implicit formulation for transient simulations.
unsteady-2nd-order-bounded?
Selects the bounded second-order implicit formulation for transient simulations.
unsteady-2nd-order?
Selects the second-order implicit formulation for transient simulations.
unsteady-global-time?
Selects the explicit transient formulation. This text command is only available for unsteady cases that
use the density-based solver with the explicit formulation.
unsteady-structure-euler?
Selects the backward Euler method for the direct time integration of the finite element semi-discrete
equation of motion. This text command is only available for transient simulations that use the structural
model.
unsteady-structure-newmark?
Selects the Newmark method for the direct time integration of the finite element semi-discrete equation
of motion. This text command is only available for transient simulations that use the structural model.
viscous/
Enters the viscous model menu.
add-intermittency-transition-model?
Enables/disables the Intermittency Transition model to account for transitional effects. This text
command is only available for the BSL - , SST - , Scale-Adaptive Simulation with BSL / SST,
and Detached Eddy Simulation with BSL / SST models.
curvature-correction-ccurv
Sets the strength of the curvature correction term. The default value is 1. This is available after the
curvature-correction? option is enabled.
curvature-correction?
Enables/disables the curvature correction.
des-limiter-option
Selects the DES limiter option (none, F1, F2, Delayed DES, or Improved Delayed DES).
geko-options/
Enters the GEKO model menu..
csep
Sets csep, the parameter to optimize flow separation from smooth surfaces.
cnw
Sets cnw, the parameter to optimize flow in non-equilibrium near wall regions.
cmix
Sets cmix, the parameter to optimize strength of mixing in free shear flows.
cjet
Sets cjet, the parameter to optimize free shear layer mixing (optimize free jets independent
of mixing layer).
blending-function
Sets the blending function, which deactivates cmix and cjet inside boundary layers.
creal
Sets creal, a realizability limiter that ensures positive normal stresses in the entire domain.
cnw_sub
Sets cnw_sub, which allows the adjustment of log-layer and cf.
cjet_aux
Sets cjet_aux, which allows fine-tuning of the parameter to optimize free jets.
cbf_tur
Sets cbf_tur, a factor for the main blending factor, controlling the thickness of the layer near
walls.
cbf_lam
Sets cbf_lam, a part of the blending function and shields the laminar boundary layer.
geko-defaults
Restores the defaults of all GEKO parameters.
wall-distance-free?
Enables/disables the wall distance free version of the GEKO model.
detached-eddy-simulation?
Enables/disables detached eddy simulation.
inviscid?
Enables/disables inviscid flow model.
ke-easm?
Enables/disables the EASM - turbulence model.
ke-realizable?
Enables/disables the realizable - turbulence model.
ke-rng?
Enables/disables the RNG - turbulence model.
ke-standard?
Enables/disables the standard - turbulence model.
k-kl-w?
Enables/disables the k-kl- turbulence model.
define/
kw-easm?
Enables/disables the EASM - turbulence model.
kw-low-re-correction?
Enables/disables the - low Re option.
kw-shear-correction?
Enables/disables the - shear-flow correction option. This text command is only available for the
standard - model and the stress-omega RSM model.
kw-bsl?
Enables/disables the baseline (BSL) - turbulence model.
kw-geko?
Enables/disables the generalized - (GEKO) turbulence model.
kw-sst?
Enables/disables the SST - turbulence model.
kw-standard?
Enables/disables the standard - turbulence model.
laminar?
Enables/disables laminar flow model.
large-eddy-simulation?
Enables/disables large eddy simulation.
les-dynamic-energy-flux?
Enables/disables the dynamic sub-grid scale turbulent Prandtl Number.
les-dynamic-scalar-flux?
Enables/disables the dynamic sub-grid scale turbulent Schmidt Number.
les-subgrid-dynamic-fvar?
Enables/disables the dynamic subgrid-scale mixture fraction variance model.
les-subgrid-smagorinsky?
Enables/disables the Smagorinsky-Lilly subgrid-scale model.
les-subgrid-tke?
Enables/disables kinetic energy transport subgrid-scale model.
les-subgrid-wale?
Enables/disables WALE subgrid-scale model.
les-subgrid-wmles-s_minus_omega?
Enables/disables the WMLES - subgrid-scale model.
les-subgrid-wmles?
Enables/disables the WMLES subgrid-scale model.
mixing-length?
Enables/disables mixing-length (algebraic) turbulence model.
multiphase-turbulence/
Enters the multiphase turbulence menu.
multiphase-options
Enables/disables multiphase options.
rsm-multiphase-models
Selects Reynolds Stress multiphase model.
turbulence-multiphase-models
Selects - multiphase model.
near-wall-treatment/
Enters the near wall treatment menu.
enhanced-wall-treatment?
Enables/disables enhanced wall functions.
menter-lechner?
Enables/disables the Menter-Lechner near-wall treatment.
non-equilibrium-wall-fn?
Enables/disables non-equilibrium wall functions.
scalable-wall-functions?
Enables/disables scalable wall functions.
standard-wall-fn?
Enables/disables standard wall functions.
user-defined-wall-functions?
Enables/disables user-defined wall functions.
werner-wengle-wall-fn?
Enables/disables Werner-Wengle wall functions.
wf-pressure-gradient-effects?
Enables/disables wall function pressure- gradient effects.
wf-thermal-effects?
Enables/disables wall function thermal effects.
reynolds-stress-model?
Enables/disables the Reynolds-stress turbulence model.
rng-differential-visc?
Enables/disables the differential-viscosity model.
rng-swirl-model?
Enables/disables swirl corrections for rng-model.
rsm-bsl-based?
Enables/disables the stress-BSL Reynolds stress model.
define/
rsm-linear-pressure-strain?
Enables/disables the linear pressure-strain model in RSM.
rsm-omega-based?
Enables/disables the stress-omega Reynolds stress model.
rsm-or-earsm-geko-option?
Enables/disables the RSM or EARSM versions of the GEKO model.
rsm-solve-tke?
Enables/disables the solution of T.K.E. in RSM model.
rsm-ssg-pressure-strain?
Enables/disables quadratic pressure-strain model in RSM.
rsm-wall-echo?
Enables/disables wall-echo effects in RSM model.
sa-alternate-prod?
Enables/disables strain/vorticity production in Spalart-Allmaras model.
sa-damping?
Enables/disables full low-Reynolds number form of Spalart-Allmaras model.
Note:
This option is only available if your response was no to sa-enhanced-wall-

treatment?.
sa-enhanced-wall-treatment?
Enables/disables the enhanced wall treatment for the Spalart-Allmaras model. If disabled, no
smooth blending between the viscous sublayer and the log-law formulation is employed, as was
done in versions previous to Fluent 14.
sas?
Enables/disables Scale-Adaptive Simulation (SAS) in combination with the SST - turbulence
model.
spalart-allmaras?
Enables/disables Spalart-Allmaras turbulence model.
transition-sst?
Enables/disables the transition SST turbulence model.
trans-sst-roughness-correlation?
Enables/disables the Transition-SST roughness correlation option.
turb-buoyancy-effects?
Enables/disables effects of buoyancy on turbulence.
turb-compressibility?
Enables/disables the compressibility correction option.
turbulence-expert/
Enters the turbulence expert menu.
kato-launder-model?
Enables/disables Kato-Launder modification.
kw-add-des?
Enables/disables Detached Eddy Simulation (DES) in combination with the currently selected
BSL - model or transition SST model. This text command is only available for transient cases.
kw-add-sas?
Enables/disables Scale-Adaptive Simulation (SAS) in combination with the currently selected
-based URANS turbulence model. This text command is only available for transient cases.
kw-vorticity-based-production?
Enables/disables vorticity-based production.
low-re-ke?
Enables/disables the low-Re - turbulence model.
low-re-ke-index
Specifies which low-Reynolds-number - model is to be used. Six models are available:
Index Model
0 Abid
1 Lam-Bremhorst
2 Launder-Sharma
3 Yang-Shih
4 Abe-Kondoh-Nagano
5 Chang-Hsieh-Chen
Contact your ANSYS, Inc. technical support engineer for more details.
production-limiter?
Enables/disables Production Limiter modification.
non-newtonian-modification?
Enables/disables non-Newtonian modification for Lam-Bremhorst model.
restore-sst-v61?
Enables/disables SST formulation of v6.1.
rke-cmu-rotation-term?
Modifies the definition for the realizable - model.
Important:
Note that the use of the realizable - model with multiple reference frames
is not recommended. This text command is provided for expert users who
want to experiment with this combination of models. Others should use it
only on the advice of a technical support engineer.
define/
sbes-sdes-hybrid-model
Selects the hybrid model, to specify whether you want to apply the Shielded Detached Eddy
Simulation (SDES) model, Stress-Blended Eddy Simulation (SBES), or SBES with a user-defined
function.
sbes-sgs-option
Selects the subgrid-scale model for the LES portion of your Stress-Blended Eddy Simulation
(SBES).
sbes-update-interval-k-omega
Sets the number of time steps between updates of the k-ω part of the SBES model.
thermal-p-function?
Enables/disables Jayatilleke P function.
turb-add-sbes-sdes?
Enables/disables the Stress-Blended Eddy Simulation (SBES) model or Shielded Detached Eddy
Simulation (SDES) model.
turb-non-newtonian?
Enables/disables turbulence for non-Newtonian fluids.
turbulence-damping?
Enables/disables turbulence damping and sets turbulence damping parameters.
turb-pk-compressible?
Enables/disables turbulent production due to compressible divergence.
user-defined
Selects user-defined functions to define the turbulent viscosity and the turbulent Prandtl and
Schmidt numbers.
user-defined-transition
Sets user-defined transition correlations.
v2f?
Enables/disables V2F turbulence model.
zero-equation-hvac?
Enables/disables zero-equation HVAC turbulence model.
named-expressions/
Enters the named expressions menu.
add/
Creates a new named expression.
compute
Computes and prints the value of an expression. This is only available for expressions that evaluate to
a single value.
delete/
Allows you to delete a named expression, as long as it is not in use.
edit/
Allows you to edit the definition of a named expression.
list/
Lists all of the currently defined named expressions.
list-properties/
Lists the definition of a named expression.
operating-conditions/
Enters the define operating conditions menu.
gravity
Sets gravitational acceleration.
gravity-mrf-rotation
Enables/disables rotation of gravity vector in moving reference frame simulations. If enabled, the
gravity vector will rotate with respect to the moving reference frame such that the direction of gravity
in global coordinates remains fixed.
operating-density?
Enables/disables use of a specified operating density. This command is available only for single-phase
flows.
operating-density/
Enters the operating density menu. This menu is available only for multiphase flows.
print-operating-density
Prints the operating density value.
set-operating-density
Allows you to select the operating density method in your simulation. You can choose from:
• 0 = minimum-phase-averaged
• 1 = primary-phase-averaged
• 2 = mixture-averaged
• 3 = user-input
See Modeling Buoyancy-Driven Multiphase Flow in the Fluent User's Guide for more inform-
ation about these options.
operating-pressure
Sets the operating pressure.
operating-temperature
Sets the operating temperature for Boussinesq.
reference-pressure-location
Sets a location that determines the reference pressure cell or cells (depending on the selected reference
pressure method). The pressure value in such cells can be used to adjust the gauge pressure field after
each iteration to keep it from floating.
reference-pressure-method
Specifies the method used for adjusting the gauge pressure field after each iteration to keep it from
floating: the method can assume that all of the cell zones are connected by internal boundary zones
define/
(such as interior zones), or can account for connected and disconnected cell zones. Such adjustment
is only allowed for incompressible flows, and will be limited partially or entirely by the presence of a
pressure boundary.
set-state
Selects state for real gas EOS subcritical condition.
used-ref-pressure-location
Prints the coordinates of the reference pressure cell or cells (depending on the selected reference
pressure method). The pressure value in such cells can be used to adjust the gauge pressure field after
each iteration to keep it from floating.
use-inlet-temperature-for-operating-density
Uses inlet temperature to calculate operating density.
overset-interfaces/
Enters the overset interfaces menu.
check
Checks the integrity of the overset interfaces. Reports orphan cells and errors in the domain connectivity.
clear
Clears the domain connectivity of an overset interface. This text command is only available when
define/overset-interfaces/options/expert is set to yes.
clear-all
Clears the domain connectivity of all overset interfaces. This text command is only available when
define/overset-interfaces/options/expert is set to yes.
create
Creates an overset interface.
cut-control/
Enters the overset hole cut control menu.
add
Adds a hole cut control, so that a boundary zone does not cut specified cell zones.
cut-seeds/
Enters the overset hole cut seeds menu.
cut-seeds-for-all-component-zones?
Specifies whether all component zones get cut seeds, which cut pilot holes into the overlapping
meshes that will then be enlarged during overlap minimization.
delete
Deletes the hole cut control for a boundary zone.
delete-all
Deletes the hole cut controls for all boundary zones.
list
Lists the defined hole cut controls.
debug-hole-cut
Debugging tool to troubleshoot hole cutting of overset interfaces. This text command is only available
when define/overset-interfaces/options/expert is set to yes.
delete
Deletes an overset interface.
delete-all
Deletes all overset interfaces in the domain.
display-cells
Displays the overset cells marked using the text command define/overset-interfaces/mark-
cells.
grid-priorities
Allows you to specify grid priorities on background and component meshes, used in the overlap min-
imization of an overset interface.
intersect
Executes the hole cutting of an overset interface and establishes the domain connectivity. This text
command is only available when define/overset-interfaces/options/expert is set to
yes.
intersect-all
Executes hole cutting for all overset interfaces in the domain. This text command is only available
list
Lists information about the overset interfaces. The output depends on the overset verbosity setting.
mark-cell-change
Marks cells that have undergone a specified overset cell type change (from solve, receptor, or
dead to any other type) in the last time step. Adaption registers are automatically filled based on these
markings. This text command is only available for unsteady simulations and if define/overset-
interfaces/options/expert is set to yes.
mark-cells
Marks the specified overset cells (solve, receptor, donor, orphan, or dead) and fills registers based on
the markings. Display the marked cells via the text command define/overset-interfaces/dis-
play-cells.
options/
Enters the overset interface options menu.
auto-create?
Enables the automatic creation of a default overset interface during initialization or mesh motion
update.
donor-priority-method
Allows you to specify whether the cell donor priority used in the overlap minimization of an overset
interface is inversely proportional to either the cell size or the distance to the nearest boundary.
expert
Enables / disables overset-related expert tools.
define/
mesh-interfaces?
Allows the inclusion of non-conformal mesh interfaces inside overset cell zones, as long as the
mesh interfaces do not spatially overlap with the cells where the overset interfaces lie.
minimize-overlap?
Allows you to disable overlap minimization during hole cutting.
modified-donor-search?
Enables / disables modified donor search parameters. When enabled, these parameters result in
a more extended donor search, which can be helpful for meshes with orphans. This text command
is only available when define/overset-interfaces/options/expert is set to yes.
modified-hole-cutting?
Enables / disables modified hole cutting parameters. When enabled, the parameters used can help
avoid dead cell zones that result from a hole cutting failure. This text command is only available
node-connected-donors?
Allows you to switch between face or node connected donor cells. This text command is only
available when define/overset-interfaces/options/expert is set to yes.
overlap-boundaries?
Allows you to disable the detection of overlapping boundaries during hole cutting, in order to reduce
the computational expense for cases that do not include such boundaries. When enabled, this text
command also allows you to specify which boundary zones should be considered when detecting
overlapping boundaries; this can be helpful when the default hole cutting process fails.
parallel
Allows you to select the algorithm used for overset parallel processing. You can select from the
default cell exchange model or the local cell zone replication model; the cell exchange model
should require less memory and may result in faster calculations.
render-receptor-cells?
Allows you to enable visualization of receptor cells in contour and mesh displays.
solve-island-removal
Sets the method used to control the removal of isolated patches of solve cells. This text command
transient-caching
Sets the options to control caching of entities in transient overset simulations. This text command
update-before-case-write?
Enables/disables the updating of the overset interfaces before writing a case file in the Common
Fluids Format (CFF). This text command is only available when define/overset-inter-
faces/options/expert is set to yes.
verbosity
Specifies the level of detail printed in the console about overset interfaces.
parameters/
Enters the parameters menu.
enable-in-TUI?
Enables/disables parameters in the text user interface.
input-parameters/
Enters the input-parameters menu.
delete
Deletes an input parameter.
edit
Edits an input parameter.
output-parameters/
Enters the output-parameters menu.
create
Creates an output parameter.
delete
Deletes an output parameter.
edit
Edits an output parameter.
print-all-to-console
Displays all parameter values in the console.
print-to-console
Displays parameter value in the console.
rename
Renames an output parameter.
write-all-to-file
Writes all parameter values to file.
write-to-file
Writes parameter value to file.
periodic-conditions/
Enters the periodic conditions menu.
massflow-rate-specification?
Enables/disables specification of mass flow rate at the periodic boundary.
pressure-gradient-specification?
Enables/disables specification of pressure gradient at the periodic boundary.
phases/
Enters the phases menu.
iac-expert/
Enters the IAC expert setting menu.
define/
hibiki-ishii-model
Sets Hibiki-Ishii model coefficients.
ishii-kim-model
Sets Ishii-Kim model coefficients.
yao-morel-model
Sets Yao-Morel model coefficients.
interaction-domain
Sets models and properties for a domain of this type.
phase-domain
Sets models and properties for a domain of this type.
set-domain-properties/
Enters the menu to set phase domain properties.
change-phases-names?
Allows you to change the names of all the phases in your simulation.
interaction-domain/
Enters the menu to set the interaction domain properties.
forces/
Enters the menu to set interfacial forces models.
drag
Specifies the drag function, drag modification, and drag factor for each pair of phases. This
command is available only with the Eulerian and Mixture multiphase models.
lift
Specifies the lift function for each pair of phases. This command is available only with the
Eulerian multiphase model.
restitution
Specifies the restitution coefficient for collisions between each pair of granular phases, and
for collisions between particles of the same granular phase. This command is available only
for multiphase flows with two or more granular phases.
slip-velocity
Specifies the slip velocity function for each secondary phase with respect to the primary
phase. This command is available only for the Mixture multiphase model.
surface-tension/
Enters the menu to set surface tension models
jump-adhesion?
Enables/disables the treatment of the contact angle specification at the porous jump
boundary. This command is available only for the VOF multiphase model with the
continuum surface stress model option and when sfc-modeling? is enabled.
sfc-modeling?
Allows you to include the effects of surface tension along the fluid-fluid interface. This
option is only available for the VOF and Eulerian multiphase models.
sfc-model-type
Selects the surface tension model. You can choose between the continuum surface
force and continuum surface stress methods. This item is available only when sfc-
modeling? is enabled.
sfc-tension-coeff
Specifies the surface tension coefficient for each pair of phases.
wall-adhesion?
Enables/disables the specification for a wall adhesion angle. This item is available only
when sfc-modeling? is enabled.
turbulent-dispersion
Specifies the turbulent dispersion model for each primary-secondary phase pair. This
command is available only with the Eulerian multiphase model.
turbulence-interaction
Specifies the turbulence interaction model for each primary-secondary phase pair. This
command is available only with the Eulerian multiphase model.
virtual-mass/
Enters the menu to set virtual mass models.
virtual-mass?
Allows you to include the virtual mass force effect that occurs when a secondary phase
accelerates relative to the primary phase. This command is available only with the Eu-
lerian multiphase model.
vmass-coeff
Specifies the virtual mass coefficient for each pair of phases. This option is available
only if virtual-mass? is enabled.
vmass-implicit?
Enables/disables the implicit method for the virtual mass force. This option can improve
convergence in some cases. This option is available only if virtual-mass? is enabled.
vmass-implicit-options
Specifies what form of the implicit method to use (default, option-2, or option-
3). default models the entire virtual mass force while option-2 and option-3
model truncated expressions which may further improve convergence. This option is
available only if vmass-implicit? is enabled.
wall-lubrication
Specifies the wall lubrication model for each primary-secondary phase pair. This command
is available only with the Eulerian multiphase model.
heat-mass-reactions/
Enters the menu to set heat, mass-transfer, and reaction models.
cavitation/
Enters the menu to set cavitation models. This option is available only for the Mixture
multiphase model with the Singhal-et-al cavitation model enabled via solve/set/ex-
pert.
define/
cavitation?
Allows you to include the effects of cavitation. When the cavitation is enabled, you
must specify vaporization pressure, surface tension coefficient, and non-condensable
gas mass fraction using the define/phases/set-domain-properties/inter-
action-domain/heat-mass-reactions/cavitation/caviation text
command. If multiple species are included in one or more secondary phases, or the
heat transfer due to phase change is considered, the mass transfer mechanism must
be defined before enabling the cavitation model.
cavitation
Sets the vaporization pressure, surface tension coefficient, and non-condensable gas
mass fraction. This command is available only when cavitation? is enabled.
heat-coeff
Species the heat transfer coefficient function between each pair of phases (constant-
htc, nusselt-number, ranz-marshall, hughmark, tomiyama, fixed-to-sat-
temp, two-resistance, or user-defined). This command is enable only with the
Eulerian multiphase model.
mass-transfer
Sets the mass transfer mechanisms.
reactions
Allows you to define multiple heterogeneous reactions and stoichiometry. This option is
available only with the species model.
interfacial-area/
Enters the menu to set interfacial area models. This menu is available only for the Mixture and
Eulerian multiphase models.
interfacial-area
Specifies the interfacial area model for each pair of phases.
model-transition/
Enters the menu to set model transition mechanisms.
model-transition
Sets the VOF-to-DPM model transition mechanism.
numerics/
Enters the menu to set numerics models. This menu is available for multiphase models with
the sharp-dispersed and phase localized discretization interface modeling options (set in
define/models/multiphase/interface-modeling-options).
interphase-discretization/
Enters the menu to set interphase discretization models.
interphase-discr?
Enables/disables phase localized compressive scheme.
slope-limiter
Specifies the slope limiter to set a specific discretization scheme for each phase pair.
A value of 0 corresponds to first order upwind, a value of 1 corresponds to second order
upwind, a value of 2 applies the compressive scheme, and a value between 0 and 2
corresponds to a blended scheme. This option is available only when interphase-
discr? is enabled.
phase-domains/
Enters the menu to select a specific phase.
phasename/
Enters the menu for setting properties for the selected phase phasename, where phasename
is the name of the phase you selected using the phase-domains/ text command.
diameter
Sets the diameter of the particles of the selected phase phasename. This text command
is available for secondary phases only.
granular-properties/
Enters the menu for setting properties for the granular phase. This text command is available
only when the granular? text command is enabled.
bulk-viscosity
Sets the solids bulk viscosity (constant, lun-et-al, or user-defined).
elasticity-modulus
Specifies the elasticity modulus (derived or user-defined).
friction-angle
Sets the angle of internal friction (constant or user-defined). This text command is
available only when schaeffer is selected as the friction viscosity model.
friction-packing
Sets a threshold volume fraction at which the frictional regime becomes dominant
(constant or user-defined). The default value is 0.61. This text command is available
only when schaeffer is selected as the friction viscosity model.
friction-viscosity
Specifies a shear viscosity based on the viscous-plastic flow (none, constant, schaeffer,
or user-defined). By default, the frictional viscosity is neglected (none).
Note:
When schaeffer is selected as the friction viscosity model, you

must specify friction-angle, friction-packing, friction-
al-modulus, and frictional-pressure.
frictional-modulus
Sets the frictional modulus (derived or user-defined). This text command is available
frictional-pressure
Sets the pressure gradient term in the granular-phase momentum equation (none,
johnson-et-al, syamlal-et-al, based-ktgf, or user-defined). This text command is available
define/
granular-conductivity
Sets temperature for the solids phase (constant, syamlal-obrien, gidaspow, or user-
defined). This text command is available only if the pde-granular? text command
is enabled.
granular-temperature
Sets temperature for the solids phase (algebraic, constant, dpm-averaged, or user-
defined). The dpm-averaged option is available only when using the Dense Discrete
Phase Model (DDPM). This text command is available only if the pde-granular?
text command is disabled.
packed-bed?
Enables/disables the packed bed model.
packing
Sets the maximum volume fraction for the granular phase (constant or user-defined).
For monodispersed spheres the packing limit is about 0.63.
pde-granular?
Enables/disables the partial differential equation (PDE) model for granular temperature.
When the PDE model is enabled, you must specify granular-conductivity.
Otherwise, you must specify granular-temperature.
radial-distribution
Sets a correction factor that modifies the probability of collisions between grains when
the solid granular phase becomes dense (lun-et-al, syamlal-obrien, ma-ahmadi,
arastoopour, or user-defined).
solids-pressure
Sets the pressure gradient term in the granular-phase momentum equation (lun-et-al,
syamlal-obrien, ma-ahmadi, user-defined, or none).
viscosity
Sets the kinetic part of the granular viscosity of the particles (constant, syamlal-obrien,
gidaspow, or user-defined).
granular?
Enables/disables the granular approach for the solid phase. This text command is available
only for secondary phases in a Eulerian multiphase case. This approach is not compatible
with the interfacial area concentration approach. For more details, see Defining a Granular
Secondary Phase in the Fluent User's Guide.
iac-properties/
Enters the menu for setting model properties for the interfacial area concentration. This
text command is available only when the iac? text command is enabled.
iac-breakage-kernel
Sets the breakage kernel (none, constant, hibiki-ishii, ishii-kim, yao-morel, or user-
defined).
iac-coalescence-kernel
Sets the coalescence kernel (none, constant, hibiki-ishii, ishii-kim, yao-morel, or user-
defined).
iac-critical-weber
Sets the critical Weber number. This value is required if you selected yao-morel as
the breakage kernel.
iac-dissipation-rate
Allows you to choose the dissipation function (constant, wu-ishii-kim, fluent-ke, or user-
defined).
iac-hydraulic-diam
Sets the hydraulic diameter. This value is required when you selected wu-ishii-kim
for the IAC dissipation rate function.
iac-max-diameter
Sets the maximum for the bubble diameters.
iac-min-diameter
Sets the minimum for the bubble diameters.
iac-nucleation-kernel
Sets the source term for the interfacial area concentration that models the rate of
formation of the dispersed phase (none, constant, yao-morel, or user-defined).
iac-surface-tension
Sets the attractive forces between the interfaces.
iac?
Enables/disables the interfacial area concentration (IAC) approach. This text command is
available for secondary phases only. The IAC approach is not compatible with the granular
approach. See Defining the Interfacial Area Concentration via the Transport Equation and
Defining the Interfacial Area Concentration in the Fluent User's Guide for details about using
the IAC approach for the Mixture and Eulerian multiphase flows.
material
Sets a material for the selected phase.
profiles/
Enters the boundary profiles menu.
delete
Deletes a profile.
delete-all
Deletes all boundary-profiles.
interpolation-method
Chooses the method for interpolation of profiles.
link-profile-to-reference-frame
Attaches a profile to a reference frame so that the profile will rotate according to the reference frame.
list-profiles
Lists all profiles.
list-profile-fields
Lists the fields of a particular profile.
define/
morphing?
Enables/disables profile morphing options in Orient Profile panel.
update-interval
Sets interval between updates of dynamic profiles.
reference-frames/
Enters the reference frames menu.
add
Creates a new reference frame.
delete
Deletes the reference frame you specify.
display
Displays the reference frame you specify.
edit
Allows you to edit a reference frame.
hide
Removes the specified reference frame from the graphics window.
list
Lists all of the reference frames.
list-properties
Lists the properties of the reference frame you specify.
set-unit-system
Applies a standard set of units to all quantities. The options include default, si, british, and cgs.
solution-strategy/
Enters the automatic initialization and case modification strategy menu.
automatic-case-modification/
Enters the automatic case modification menu.
before-init-modification
Specifies modification to be performed before initialization.
modifications
Specifies modifications to be performed during solution.
original-settings
Specifies modification to be performed after initialization to restore to original settings.
automatic-initialization
Defines how the case is to be automatically initialized.
continue-strategy-execution
Continues execution of the currently defined automatic initialization and case modification strategy.
enable-strategy?
Enables/disables automatic initialization and case modification.
execute-strategy
Executes the currently defined automatic initialization and case modification strategy.
turbo-model/
Enters the turbo menu.
enable-turbo-model?
Enables/disables turbo model menu.
turbo-create
Creates a general turbo interface.
general-turbo-interface-settings/
Enters the General Turbo Interface options menu.
mixing-plane-model-settings
Defines settings for the mixing plane model.
bands-type
Specifies the averaging bands for mixing as fixed or variable width.
number-of-bands
Sets the number of bands to be used for mixing.
number-of-inner-iterations
Sets the number of iterations used in averaging.
no-pitch-scale-model-settings
Defines settings for the no pitch-scale model.
scale-mflux?
Scales mass flux to improve conservation.
pitch-scale-model-settings
Defines settings for the pitch-scale model.
scale-mflux?
Scales mass flux to improve conservation.
turbo-topology/
Enters the turbo topology menu.
define-topology
Defines a turbo topology.
mesh-method
Sets turbo structured mesh generation method.
search-method
Sets search method for a topology.
define/
projection-method
Sets 2D projection method.
units
Sets unit conversion factors.
user-defined/
Enters the user-defined functions and scalars menu.
1D-coupling
Loads 1D library.
compiled-functions
Opens user-defined function library.
execute-on-demand
Executes UDFs on demand.
fan-model
Configures user-defined fan model.
function-hooks
Hooks up user-defined functions.
interpreted-functions
Loads interpreted user-defined functions.
real-gas-models
Enters the real-gas menu to enable/configure real gas model.
nist-multispecies-real-gas-model
Loads the NIST real-gas library.
nist-real-gas-model
Loads the NIST real-gas library.
nist-settings
Specifies the name and the location for the REFPROP library and fluid files.
set-state
Selects the state for NIST real gas model.
user-defined-multispecies-real-gas-model
Loads a user-defined multispecies real-gas library.
user-defined-real-gas-model
Loads the user-defined real-gas library.
use-contributed-cpp?
Enables/disables use of the cpp utility included with the ANSYS Fluent installation.
user-defined-memory
Allocates user-defined memory.
user-defined-scalars
Defines user-defined scalars.
Chapter 4: display/
add-custom-vector
Adds new custom vector definition.
annotate
Adds annotation text to a graphics window. It will prompt you for a string to use as the annotation text,
and then a dialog box will prompt you to select a screen location using the mouse-probe button on your
mouse.
clear-annotations
Removes all annotations and attachment lines from the active graphics window.
close-window
Closes a graphics window.
contour
Prompts for a scalar field and minimum and maximum values, and then displays a contour plot.
display-custom-vector
Displays custom vector.
flamelet-data
Displays flamelet data.
carpet-plot
Enables/disables display of carpet plot of a property.
draw-number-box?
Enables/disables display of the numbers box.
plot-1d-slice?
Enables/disables plot of the 1D-slice.
write-to-file?
Enables/disables writing the 1D-slice to file instead of plot.
graphics-window-layout
Arranges the graphics window layout.
hsf-file
Loads an HSF file for viewing.
mesh
Displays the entire mesh. For 3D, you will be asked to confirm that you really want to draw the entire mesh
(not just the mesh-outline).
mesh-outline
Displays the mesh boundaries.
display/
mesh-partition-boundary
Displays mesh partition boundaries.
multigrid-coarsening
Displays a coarse mesh level from the last multigrid coarsening.
objects
Enters the graphics objects menu.
add-to-graphics
Adds a contour, vector, pathline, particle track, scene, or mesh plot to the existing content in the
graphics window.
copy
Copies an existing contour, vector, pathline, particle track, scene, mesh, or XY plot definition.
create
Creates a contour, vector, pathline, particle track, scene, mesh, or XY plot definition.
delete
Deletes a contour, vector, pathline, particle track, scene, mesh, or XY plot definition.
display
Displays a contour, vector, pathline, particle track, scene, mesh, or XY plot in the graphic windows re-
placing the existing content.
edit
Edits a contour, vector, pathline, particle track, scene, or mesh plot definition.
open-window
Opens a graphics window.
particle-tracks/
Enters the particle tracks menu.
particle-tracks
Calculates and displays particle tracks from defined injections.
plot-write-xy-plot
Plots or writes an XY plot of particle tracks.
path-lines/
Enters the pathlines menu.
path-lines
Displays pathlines from a surface.
plot-write-xy-plot
Plots or writes an XY plot of pathlines.
write-to-files
Writes pathlines to a file.
pdf-data/
Enters the PDF data menu.
carpet-plot
Enables/disables the display of a carpet plot of a property.
draw-number-box?
Enables/disables the display of the numbers box.
plot-1d-slice?
Enables/disables a plot of the 1D-slice.
write-to-file?
Enables/disables writing the 1D-slice to file instead of plot.
reacting-channel-curves
Plots the reacting channel variables.
profile
Displays profiles of a flow variable.
re-render
Re-renders the last contour, profile, or vector plot with updated surfaces, meshed, lights, colormap, rendering
options, and so on, without recalculating the contour data.
re-scale
Re-renders the last contour, profile, or vector plot with updated scale, surfaces, meshes, lights, colormap,
rendering options, and so on, but without recalculating the field data.
save-picture
Generates a “hardcopy" of the active window.
set/
Enters the set menu to set display parameters.
color-map/
Enters the color map menu, which contains names of predefined and user-defined (in the Colormap
Editor panel) colormaps that can be selected. It prompts you for the name of the colormap to be used.
colors/
Enters the color options menu.
axis-faces
Sets the color of axisymmetric faces.
background
Sets the background (window) color.
color-by-type?
Determines whether to color meshes by type or by ID.
far-field-faces
Sets the color of far field faces.
free-surface-faces
Sets the color of free-surface faces.
display/
graphics-color-theme
Sets the color theme for the graphics window. The color options are for the background display,
but changing the theme also changes the default colors for items that display in the graphics
windows, like faces and edges.
foreground
Sets the foreground (text, ruler, and window frame) color.
highlight-color
Sets highlight color.
inlet-faces
Sets the color of inlet faces.
interface-faces
Sets the color of mesh interfaces.
interior-faces
Sets the color of interior faces.
internal-faces
Sets the color of internal interface faces.
outlet-faces
Sets the color of outlet faces.
periodic-faces
Sets the color of periodic faces.
rans-les-interface-faces
Sets the color of RANS/LES interface faces.
symmetry-faces
Sets the color of symmetric faces.
traction-faces
Sets the color of traction faces.
wall-faces
Sets the color of wall faces.
list
Lists available colors.
reset-colors
Resets individual mesh surface colors to the defaults.
skip-label
Sets the number of labels to be skipped in the colormap scale.
surface
Sets the color of surfaces.
contours/
Enters the contour options menu.
auto-range?
Enables/disables auto-computation of the contour range.
clip-to-range?
Turns the clip to range option for filled contours on/off.
coloring
Specifies whether contours are displayed in bands or with smooth transitions. Note that you can
only display smooth contours if node-values are enabled.
contour-lines?
With the filled-contours? and node-values? options enabled, this sets the use of lines
to delineate the bands of color to coincide with the colormap.
filled-contours?
Turns the filled contours option on/off (deselects line-contours?).
global-range?
Turns the global range for contours on/off.
line-contours?
Turns the line contours option on/off (deselects filled-contours?).
log-scale?
Specifies a decimal or logarithmic color scale for contours.
n-contour
Sets the number of contour levels.
node-values?
Sets the option to use scalar field at nodes when computing the contours.
render-mesh?
Determines whether or not to render the mesh on top of contours, vectors, and so on.
surfaces
Sets the surfaces on which contours are drawn. You can include a wildcard (*) within the surface
names.
element-shrink
Sets shrinkage of both faces and cells. A value of zero indicates no shrinkage, while a value of one will
shrink each face or cell to a point.
filled-mesh?
Determines whether the meshes are drawn as wireframe or solid.
mesh-level
Sets coarse mesh level to be drawn.
mesh-partitions?
Enables/disables option to draw mesh partition boundaries.
mesh-surfaces
Sets surface IDs to be drawn as meshes. You can include a wildcard (*) within the surface names.
display/
mesh-zones
Sets zone IDs to be drawn as meshes.
picture/
Enters the save-picture options menu.
color-mode/
Enters the hardcopy/save-picture color mode menu.
color
Plots hardcopies in color.
gray-scale
Converts color to grayscale for hardcopy.
list
Displays the current hardcopy color mode.
mono-chrome
Converts color to monochrome (black and white) for hardcopy.
x-resolution
Sets the width of raster-formatted images in pixels (0 implies current window size).
y-resolution
Sets the height of raster-formatted images in pixels (0 implies current window size).
dpi
Sets the resolution for EPS and Postscript files; specifies the resolution in dots per inch (DPI) instead
of setting the width and height.
driver/
Enters the set hardcopy driver menu.
dump-window
Sets the command used to dump the graphics window to a file.
eps
Produces encapsulated PostScript (EPS) output for hardcopies.
hsf
Produces HOOPS Visualize Stream Format (HSF) output for hardcopies.
jpeg
Produces JPEG output for hardcopies. (This is the default file type.)
list
Lists the current hardcopy driver.
options
Sets the hardcopy options. Available options are:“no gamma correction", disables gamma correction
of colors;“pen speed = f", where f is a real number in [0,1];“physical size = (width, height)", where
width and height are the actual measurements of the printable area of the page in centimeters;
“subscreen = (left, right, bottom, top)", where left, right, bottom, and top are numbers in [-1,1]
describing a subwindow on the page in which to place the hardcopy. The options may be combined
by separating them with commas. The pen speed option is only meaningful to the HPGL driver.
png
Uses PNG output for hardcopies.
post-format/
Enters the PostScript driver format menu.
fast-raster
Enables a raster file that may be larger than the standard raster file, but will print much more
quickly.
raster
Enables the standard raster file.
rle-raster
Enables a run-length encoded raster file that will be about the same size as the standard raster
file, but will print slightly more quickly.
vector
Enables the standard vector file.
post-script
Produces PostScript output for hardcopies.
ppm
Produces PPM output for hardcopies.
tiff
Produces TIFF output for hardcopies.
vrml
Uses VRML output for hardcopies.
invert-background?
Exchanges foreground/background colors for hardcopy.
landscape?
Plots hardcopies in landscape or portrait orientation.
jpeg-hardcopy-quality
Controls the size and quality of how JPEG files are saved based on a scale of 0-100, with zero being
low quality small files and 100 being high quality larger files.
preview
Applies the settings of the color-mode, invert-background, and landscape options to the currently
active graphics window to preview the appearance of printed hardcopies.
use-window-resolution?
Disables/enables the use of the current graphics window resolution when saving an image of the
graphics window. If disabled, the resolution will be as specified for x-resolution and y-resolu-
tion.
display/
lights/
Enters the lights menu.
headlight-on?
Turns the light that moves with the camera on or off. This is controlled automatically by default.
lighting-interpolation
Sets lighting interpolation method.
automatic
Fluent automatically picks the best lighting method for the display in the graphics window.
flat
Uses flat shading for meshes and polygons.
gouraud
Uses Gouraud shading to calculate the color at each vertex of a polygon and interpolates it in
the interior.
phong
Uses Phong shading to interpolate the normals for each pixel of a polygon and computes a
color at every pixel.
lights-on?
Turns all active lighting on/off. This command is only available when the headlight-on? option
is turned off (lights-on? is enabled when the headlight is on).
set-ambient-color
Sets the ambient color for the scene. The ambient color is the background light color in a scene.
set-light
Adds or modifies a directional, colored light.
line-weight
Sets the line-weight factor for the window.
marker-size
Sets the size of markers used to represent points.
marker-symbol
Sets the type of markers used to represent points.
mesh-display-configuration
Changes the default mesh display. If set to meshing, it draws the mesh on edges and faces of the
outline surfaces, colored by their zone ID with lighting enabled. If set to solution, it draws the mesh
on edges and faces of the outline surfaces, colored by their zone type with lighting enabled. If set to
post-processing, it draws the object outline with lighting disabled. If set to classic, it draws the mesh
on all edges of the outline surfaces.
Note:
This only applies for 3D cases.
mirror-zones
Sets the zones about which the domain is mirrored (symmetry planes).
mouse-buttons
Prompts you to select a function for each of the mouse buttons.
mouse-probes?
Enables/disables mouse probe capability.
n-stream-func
Sets number of iterations used in computing stream function.
nodewt-based-interp?
Disables/enables the use of node weights for node-based gradients in postprocessing.
overlays?
Enables/disables overlays.
particle-tracks/
Enters the particle-tracks menu to set parameters for display of particle tracks.
arrow-scale
Sets the scale factor for arrows drawn on particle tracks.
arrow-space
Sets the spacing factor for arrows drawn on particle tracks.
coarsen-factor
Sets the coarsening factor for particle tracks.
display?
Determines whether particle tracks shall be displayed or only tracked.
filter-settings/
Sets filter for particle display.
enable-filtering?
Specifies whether particle display is filtered.
filter-variable
Selects a variable used for filtering of particles.
inside?
Specifies whether filter variable must be inside min/max to be displayed (else outside min/max).
maximum
Specifies the upper bound for the filter variable.
minimum
Specifies the lower bound for the filter variable.
history-filename
Specifies the name of the particle history file.
display/
line-width
Sets the width for particle track.
marker-size
Sets the size of markers used to represent particle tracks.
particle-skip
Specifies how many particle tracks should be displayed.
radius
Sets the radius for particle track (ribbon/cylinder only) cross-section.
report-to
Specifies the destination for the report (console, file, none).
report-type
Sets the report type for particle tracks.
report-variables
Sets the report variables.
report-default-variables
Sets the report variables to default.
sphere-attrib
Specifies the size and number of slices to be used in drawing spheres.
sphere-settings/
Sets filter for particle display.
auto-range?
Specifies whether displayed spheres should include auto range of variable to size spheres.
diameter
Diameter of the spheres when vary-diameter is disabled.
maximum
Sets the maximum value of the sphere to be displayed.
minimum
Sets the minimum value of the sphere to be displayed.
scale-factor
Specifies a scale factor to enlarge/reduce the size of spheres.
size-variable
Selects a particle variable to size the spheres.
smooth-parameter
Specifies number of slices to be used in drawing spheres.
vary-diameter?
Specifies whether the spheres can vary with another variable.
style
Sets the display style for particle track (line/ribbon/cylinder/sphere).
track-single-particle-stream?
Specifies the stream ID to be tracked.
twist-factor
Sets the scale factor for twisting (ribbons only).
vector-settings/
Sets vector specific input.
color-variable?
Specifies whether the vectors should be colored by variable specified in /display/particle-
track/particle-track (if false use a constant color).
constant-color
Specifies a constant color for the vectors.
length-to-head-ratio
Specifies ratio of length to head for vectors and length to diameter for cylinders.
length-variable?
Specifies whether the displayed vectors have length varying with another variable.
scale-factor
Specifies a scale factor to enlarge/reduce the length of vectors.
style
Enables and sets the display style for particle vectors (none/vector/centered-vector/centered-
cylinder).
vector-length
Specifies the length of constant vectors.
vector-length-variable
Selects a particle variable to specify the length of vectors.
vector-variable
Selects a particle vector function to specify vector direction.
path-lines/
Sets parameters for display of pathlines.
arrow-scale
Sets the scale factor for arrows drawn on pathlines.
arrow-space
Sets the spacing factor for arrows drawn on pathlines.
display-steps
Sets the display stepping for pathlines.
error-control?
Sets error control during pathline computation.
display/
line-width
Sets the width for pathlines.
marker-size
Sets the marker size for particle drawing.
maximum-error
Sets the maximum error allowed while computing the pathlines.
maximum-steps
Sets the maximum number of steps to take for pathlines.
radius
Sets the radius for pathline (ribbons/cylinder only) cross-section.
relative-pathlines?
Enables/disables the tracking of pathlines in a relative coordinate system.
reverse?
Sets direction of path tracking.
sphere-attrib
Specifies the size and number of slices to be used in drawing spheres.
step-size
Sets the step length between particle positions for pathlines.
style
Selects the pathline style (line, point, ribbon, triangle, cylinder).
time-step
Sets the time step between particle positions for pathlines.
track-in-phase
Selects the phase in which particle pathlines will be computed (Multiphase Eulerian Model only).
twist-factor
Sets the scale factor for twisting (ribbons only).
periodic-repeats
Sets number of periodic repetitions.
proximity-zones
Sets zones to be used for boundary cell distance and boundary proximity.
render-mesh?
Enables/disables rendering the mesh on top of contours, vectors, and so on.
rendering-options
Enters the rendering options menu, which contains the commands that allow you to set options that
determine how the scene is rendered.
animation-option
Uses of wireframe or all during animation.
auto-spin?
Enables/disables mouse view rotations to continue to spin the display after the button is released.
color-map-alignment
Sets the color bar alignment.
device-info
Prints out information about your graphics driver.
double-buffering?
Enables/disables double buffering. Double buffering dramatically reduces screen flicker during
graphics updates. If your display hardware does not support double buffering and you turn this
option on, double buffering will be done in software. Software double buffering uses extra memory.
driver
Changes the current graphics driver. When enabling graphics display, you have various options:
for Linux, the available drivers include opengl and x11; for Windows, the available drivers include
opengl, dx11 (for DirectX 11), and msw (for Microsoft Windows). You can also disable the
graphics display window by entering null. For a comprehensive list of the drivers available to
you, press the Enter key at the driver> prompt.
Note:
For any session that displays graphics in a graphics window and/or saves picture
files, having the driver set to x11, msw, or null will cause the rendering / saving
speed to be significantly slower.
face-displacement
Sets face displacement value in Z-buffer units along the Camera Z-axis.
hidden-line-method
Specifies the method to perform hidden line rendering. This command will appear only when
hidden-lines? is true.
normal-hlr-algorithm
Normal hidden lines algorithm. This is the default.
mesh-display-hlr?
For removing hidden lines for surfaces that are very close together. Use this if normal-hlr-
algorithm is not working. This will only work for meshes.
Note:
These commands (only available when Graphics Color Theme is set to Black)
are deprecated and will be removed at a future release.
display/
hidden-lines?
Turns hidden line removal on/off.
Note:
This command (only available when Graphics Color Theme is set to Black) is
deprecated and will be removed at a future release.
hidden-surfaces?
Turns hidden surface removal on/off.
hidden-surface-method/
Allows you to choose from among the hidden surface removal methods that ANSYS Fluent supports.
These options (listed below) are display hardware dependent.
hardware-z-buffer
Is the fastest method if your hardware supports it. The accuracy and speed of this method is
hardware dependent.
painters
Will show less edge-aliasing effects than hardware-z- buffer. This method is often used instead
of software-z-buffer when memory is limited.
software-z-buffer
Is the fastest of the accurate software methods available (especially for complex scenes), but
it is memory intensive.
z-sort-only
Is a fast software method, but it is not as accurate as software-z-buffer.
outer-face-cull?
Enables/disables discarding outer faces during display.
set-rendering-options
Sets the rendering options.
surface-edge-visibility
Sets edge visibility flags for surfaces.
reset-graphics
Resets the graphics system.
title
Sets problem title. This text only appears if the display/set/windows/text/company? text
command is set to yes and if Titles is enabled in the Display Options dialog box.
left-top
Sets the title text for left top in title segment.
left-bottom
Sets the title text for left bottom in title segment.
right-top
Sets the title text for right top in title segment.
right-middle
Sets the title text for right middle in title segment.
right-bottom
Sets the title text for right bottom in title segment.
velocity-vectors/
Enters the menu to set parameters for display of velocity vectors.
auto-scale?
Auto-scales all vectors so that vector overlap is minimal.
color
Sets the color of all velocity vectors to the color specified. The color scale is ignored. This is useful
when overlaying a vector plot over a contour plot.
color-levels
Sets the number of colors used from the colormap.
component-x?
Sets the option to use only the component of the velocity vectors during display.
component-y?
component-z?
constant-length?
Sets the option to draw velocity vectors of constant length. This shows only the direction of the
velocity vectors.
global-range?
Turns global range for vectors on/off.
in-plane?
Toggles the display of velocity vector components in the plane of the surface selected for display.
log-scale?
Toggles whether color scale is logarithmic or linear.
node-values?
Enables/disables the plotting of node values. Cell values will be plotted if "no".
relative?
Toggles the display of relative velocity vectors.
render-mesh?
Enables/disables rendering the mesh on top of contours, vectors, and so on.
scale
Sets the value by which the vector length will be scaled.
scale-head
Sets the value by which the vector head will be scaled.
display/
style
Specifies the vector style that will be used when the vectors are displayed. You can choose from:
3d arrow, 3d arrowhead, cone, filled-arrow, arrow, harpoon, or headless.
surfaces
Sets surfaces on which vectors are drawn. You can include a wildcard (*) within the surface names.
windows/
Enters the windows option menu, which contains commands that allow you to customize the relative
positions of subwindows inside the active graphics window.
aspect-ratio
Sets the aspect ratio of the active window.
axes/
Enters the axes window options menu (3D only).
border?
Sets whether to draw a border around the axes window.
bottom
Sets the bottom boundary of the axes window.
clear?
Sets the transparency of the axes window.
logo?
Enables/disables visibility of the logo in graphics window.
logo-color
Sets logo color to white/black in graphics window.
right
Sets the right boundary of the axes window.
visible?
Turns axes visibility on/off.
main/
Enters the main view window options menu.
border?
Sets whether or not to draw a border around the main viewing window.
bottom
Sets the bottom boundary of the main viewing window.
left
Sets the left boundary of the main viewing window.
right
Sets the right boundary of the main viewing window.
top
Sets the top boundary of the main viewing window.
visible?
Turns visibility of the main viewing window on/off.
ruler?
Turns the ruler on/off. Note that if you are running Fluent in 3D, then the view must be set to or-
thographic.
scale/
Enters the color scale window options menu.
alignment
Sets the colormap position to the bottom, left, top, or right.
border?
Sets whether or not to draw a border around the color scale window.
bottom
Sets the bottom boundary of the color scale window.
clear?
Sets the transparency of the scale window.
format
Sets the number format of the color scale window. (for example, %0.2e)
font-size
Sets the font size of the color scale window.
left
Sets the left boundary of the color scale window.
margin
Sets the margin of the color scale window.
right
Sets the right boundary of the color scale window.
top
Sets the top boundary of the color scale window.
visible?
Turns visibility of the color scale window on/off.
text/
Enters the text window options menu.
application?
Shows/hides the application name in the picture.
border?
Sets whether or not to draw a border around the text window.
bottom
Sets the bottom boundary of the text window.
display/
clear?
Enables/disables text window transparency.
company?
Enables/disables the display of your company name or other text defined using the dis-
play/set/titles/ text command. The text appears in the title box. See Controlling the
Titles, Axes, Ruler, Logo, and Colormap in the Fluent User's Guide for additional information.
date?
Shows/hides the date in the picture.
left
Sets the left boundary of the text window.
right
Sets the right boundary of the text window.
top
Sets the top boundary of the text window.
visible?
Turns visibility of the text window on/off.
video/
Enters the video window options menu.
background
Sets the background color of the graphics window. The color is specified as a string of three
comma-separated numbers between 0 and 1, representing red, green, and blue. For example,
to change the background from black (default) to gray, you would enter ".5,.5,.5" after
selecting the background command.
color-filter
Sets the video color filter. For example, to change the color filter from its default setting to PAL
video with a saturation of 80% and a brightness of 90%, you would enter
"video=pal,sat=.8,gain=.9" after selecting the color-filter command.
foreground
Sets the foreground (text) color of the graphics window. The color is specified as a string of
three comma-separated numbers between 0 and 1, representing red, green, and blue. For ex-
ample, to change the foreground from white (default) to gray, you would enter ".5,.5,.5"
after selecting the foreground command.
on?
Enables/disables video picture settings.
pixel-size
Sets the window size in pixels.
xy/
Enters the XY plot window options menu.
border?
Sets whether or not to draw a border around the XY plot window.
bottom
Sets the bottom boundary of the XY plot window.
left
Sets the left boundary of the XY plot window.
right
Sets the right boundary of the XY plot window.
top
Sets the top boundary of the XY plot window.
visible?
Turns visibility of the XY plot window on/off.
zero-angle-dir
Sets the vector having zero angular coordinates.
set-list-tree-separator
Sets the separator character for list tree.
set-window
Sets a graphics window to be the active window.
surface/
Enters the data surface-manipulation menu. For a description of the items in this menu, see sur-
face/ (p. 381).
surface-cells
Draws the cells on the specified surfaces. You can include a wildcard (*) within the surface names.
surface-mesh
Draws the mesh defined by the specified surfaces. You can include a wildcard (*) within the surface names.
update-scene/
Enters the scene options menu.
delete
Deletes selected geometries.
display
Displays selected geometries.
draw-frame?
Enables/disables drawing the bounding frame.
iso-sweep
Changes iso-sweep values.
overlays?
Enables/disables the overlays option.
pathline
Changes pathline attributes.
display/
select-geometry
Selects geometry to be updated.
set-frame
Changes frame options.
time
Changes time-step value.
transform
Applies transformation matrix on selected geometries.
vector
Displays vectors of a space vector variable.
velocity-vector
Prompts for a scalar field by which to color the vectors, the minimum and maximum values, and the scale
factor, and then draws the velocity vectors.
view/
Enters the view manipulation menu. For a description of the items in this menu, see views/ (p. 387).
zone-mesh
Draws the mesh defined by specified face zones. Zone names can be indicated using wildcards (*).
Chapter 5: exit / close-fluent
exit
Exits program.
close-fluent
(ANSYS Fluent in Workbench only) Exits program.
Chapter 6: file/
async-optimize?
Chooses whether to optimize file I/O using scratch disks and asynchronous operations.
auto-save/
Enters the auto save menu.
append-file-name-with
Sets the suffix for auto-saved files. The file name can be appended by flow-time, time-step value, or
by user-specified flags in file name.
case-frequency
Specifies the frequency (in iterations, time steps, or flow time) with which case files are saved.
data-frequency
Specifies the frequency (in iterations, time steps, or flow time) with which data files are saved.
max-files
Sets the maximum number of files. Once the maximum is reached, files will be erased as new files are
written.
overwrite-existing-files
Overwrites existing files when files are automatically saved.
retain-most-recent-files
Sets autosave to retain the 5 most recent files.
root-name
Specifies the root name for the files that are saved.
save-data-file-every
Specifies the type and frequency of the data file to be saved.
binary-files?
Indicates whether to write binary or text format case and data files.
Important:
Common Fluids Format (CFF) Files are always saved in binary format (and therefore
cannot be saved in ASCII format), so setting this command to 'no' has no effect on CFF
files, only the legacy (.cas and .dat) format.
cff-files?
Specifies which format used to write case and data files, and which format is prioritized when reading.
Answering yes specifies that the Common Fluids Format (.cas.h5 and .dat.h5) is used, whereas no
specifies that the legacy format (.cas and .dat) is used.
file/
cffio-options/
Enters the cffio options menu, which provides options for the I/O of case and data files in the Common
Fluids Format (CFF).
compression-level
Sets the compression level for CFF files. The compression level can be set between 0 and 9 with 0 being
least compression (fastest) and 9 being highest compression (slowest).
io-mode
Sets the I/O mode for writing CFF files.
1. HOST: I/O is done serially by the host process.

2. NODE0: I/O is done serially by the node 0 process.
3. PARALLEL INDEPENDENT: I/O is done in parallel using the independent mode of MPI
I/O.
4. PARALLEL COLLECTIVE: I/O is done in parallel using the collective mode of MPI I/O.
single-precision-data?
Specifies whether the double-precision solver saves single-precision data when writing CFF data files,
in order to reduce the size of the files.
close-without-save?
Exits ANSYS Fluent without saving data in Workbench. This command is only available when running ANSYS
Fluent in Workbench.
confirm-overwrite?
Confirms attempts to overwrite existing files.
data-file-options
Sets derived quantities to be written in data file.
define-macro
Saves input to a named macro.
em-mapping
Enters the electromagnetic loss mapping menu.
Important:
When ANSYS Fluent is run under Workbench and a connection is detected between the
ANSYS Fluent and ANSYS Maxwell applications, the em-mapping text command menu
includes only the volumetric-energy-loss and surface-energy-loss com-
mands. The maintain-loss-on-initialization and remove-loss-only
commands are available when there is no connection between ANSYS Fluent and ANSYS
Maxwell and Fluent has electromagnetic loss data; Fluent can receive this loss data
through a connection or from a previously solved data file.
maintain-loss-on-initialization
Maintains the loss data provided by Maxwell even if solution is initialized.
remove-loss-only
Removes the loss data provided by Maxwell and keeps all other solution data.
surface-energy-loss
Maps the total surface loss (that is, heat source) from Maxwell to ANSYS Fluent so that you can perform
a thermal analysis. This option is only available when there is a connection detected between the
ANSYS Fluent and Maxwell applications.
volumetric-energy-loss
Maps the total volumetric loss (that is, heat source) from Maxwell to ANSYS Fluent so that you can
perform a thermal analysis. This option is only available when there is a connection detected between
the ANSYS Fluent and Maxwell applications.
execute-macro
Runs a previously defined macro.
export-to-cfd-post
Exports data files that are compatible with CFD-Post and EnSight (that is, .cdat and .cst files) and opens
CFD-Post, if desired.
export/
Exports case and data information.
abaqus
Writes an ABAQUS file.
ascii
Writes an ASCII file.
avs
Writes an AVS UCD file.
cdat-for-cfd-post-&-ensight
Writes data files that are compatible with CFD-Post and EnSight (that is, .cdat and .cst files).
cgns
Writes a CGNS file.
custom-heat-flux
Writes a generic file for heat transfer.
dx
Writes an IBM Data Explorer format file.
ensight
Writes EnSight geometry, velocity, and scalar files.
ensight-gold
Writes EnSight Gold geometry, velocity, and scalar files.
ensight-gold-parallel-surfaces
Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for
EnSight Enterprise.
ensight-gold-parallel-volume
Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for
EnSight Enterprise.
file/
ensight-gold-transient
Writes EnSight Gold Transient geometry, velocity, and scalar files.
fast-mesh
Writes FAST/Plot3D unstructured mesh file.
fast-scalar
Writes FAST/Plot3D unstructured scalar function file.
fast-solution
Writes FAST/Plot3D unstructured solution file.
fast-velocity
Writes FAST/Plot3D unstructured vector function file.
fieldview
Writes FIELDVIEW case and data files.
fieldview-data
Writes FIELDVIEW case and data files.
fieldview-unstruct
Writes FIELDVIEW unstructured combined file.
fieldview-unstruct-mesh
Writes FIELDVIEW unstructured mesh-only file.
fieldview-unstruct-data
Writes FIELDVIEW unstructured results-only file.
fieldview-unstruct-surfaces
Writes FIELDVIEW unstructured file for surfaces. You are prompted to select either [1], [2] or [3] to
write either mesh-only, results-only, or combined for surfaces (respectively).
gambit
Writes GAMBIT neutral file.
icemcfd-for-icepak
Writes a binary ICEM CFD domain file.
ideas
Writes an I-deas universal file.
mechanical-apdl-input
Writes a Mechanical APDL Input file.
nastran
Writes a NASTRAN file.
particle-history-data
Exports particle-history data.
patran-neutral
Writes a PATRAN neutral file.
patran-nodal
Writes a PATRAN nodal results file.
system-coupling-definition-file-settings/
Enters the system coupling file (.scp) menu.
enable-automatic-creation-of-scp-file
enables/disables automatically writing a .scp every time a case file is written.
write-system-coupling-file
Writes a system coupling (.scp) file.
taitherm
Exports TAITherm file.
tecplot
Writes a Tecplot+3DV format file.
fsi/
Enters the fluid-structure interaction menu.
display-fsi-mesh
Displays the mesh for a fluid-structure interaction.
read-fsi-mesh
Reads an FEM mesh for one-way data mapping from ANSYS Fluent.
write-fsi-mesh
Writes a fluid-structure interaction mesh file.
import/
Imports case and data information.
abaqus/
Imports an ABAQUS file.
fil
Reads an ABAQUS .fil result file as a case file.
input
Reads an ABAQUS input file as a case file.
odb
Reads an ABAQUS odb file as a case file.
cfx/
Imports a CFX file.
definition
Reads a CFX definition file as a case file.
result
Reads a CFX definition file as a case file.
file/
cgns/
Imports a CGNS file.
data
Reads data from CGNS file.
mesh
Imports a CGNS mesh file.
mesh-data
Imports a CGNS mesh file and data file.
chemkin-mechanism
Reads a CHEMKIN mechanism file.
chemkin-report-each-line?
Enables/disables reporting after reading each line.
ensight
Reads an EnSight file as a case file.
fidap
Imports a FIDAP neutral file.
flamelet/
Imports a flamelet file.
standard
Reads a standard format flamelet file.
cfx-rif
Reads a CFX-RIF format flamelet file.
fluent4-case
Imports a formatted ANSYS Fluent 4 case file.
fmu-file/
Enters the import FMU file menu.
define-fmu
Links the FMU variables with the Fluent output parameters.
import-fmu
Imports an FMU file.
gambit
Imports a GAMBIT neutral file.
hypermesh
Reads a HYPERMESH file as a case file.
ideas-universal
Imports an I-deas Universal file.
lstc/
Imports an LSTC file.
input
Reads an LSTC input file as a case file.
state
Reads an LSTC result file as a case file.
marc-post
Reads a MARC POST file as a case file.
mechanical-apdl/
Imports a Mechanical APDL file.
input
Reads a Mechanical APDL file as a case file.
result
Reads a Mechanical APDL result file as a case file.
nastran/
Imports a NASTRAN file.
bulkdata
Reads a NASTRAN file as a case file.
output2
Reads a NASTRAN op2 file as a case file.
partition/
Enters the partition menu to set conditions for partitioning an ANSYS Fluent case file during read.
metis
Reads and partitions an ANSYS Fluent case file.
metis-zone
Reads and partitions an ANSYS Fluent case file.
patran/
Imports a PATRAN neutral file (zones defined by named components).
neutral
Reads a PATRAN Neutral file (zones defined by named components) as a case file.
plot3d/
Imports a PLOT3D file.
mesh
Reads a PLOT3D file as a case file.
tecplot
Enters the Tecplot menu.
file/
mesh
Reads a Tecplot binary file as a case file.
prebfc-structured
Imports a formatted PreBFC structured mesh file.
ptc-mechanica
Reads a PTC Mechanica Design file as a case file.
load-act-tool
Loads the ANSYS ACT simulation customization tool.
interpolate/
Interpolates data to/from another grid.
read-data
Reads and interpolates data.
write-data
Writes data for interpolation.
zone-selection
Defines a list of cell zone IDs. If specified, interpolation data will be read/written for these cell zones
only.
read-case
Reads a case file.
read-case-data
Reads a case and a data file.
read-data
Reads a data file.
read-field-functions
Reads custom field function definitions from a file.
read-injections
Reads all DPM injections from a file.
read-isat-table
Reads ISAT Table.
read-journal
Reads command input from one or more files.
read-macros
Reads macro definitions from a file.
read-pdf
Reads a PDF file.
read-profile
Reads boundary profile data.
read-rays
Reads a ray file.
read-settings
Reads and sets boundary conditions from a specified file.
read-surface-clusters
Reads surface clusters from a file.
read-transient-table
Reads table of transient boundary profile data.
read-viewfactors
Reads view factors from a file.
reload-setup
Discards any changes in the current ANSYS Fluent in Workbench session and removes any corresponding
data from the Solution cell. This command is only available when running ANSYS Fluent in Workbench.
replace-mesh
Replaces the mesh with a new one while preserving settings.
set-batch-options
Sets the batch options.
set-idle-timeout
Allows you to set an idle timeout so that an idle ANSYS Fluent session will automatically save and close
after the specified time.
set-tui-version
Allows you to improve backwards compatibility for journal files. This command hides any new TUI prompts
that are added at a future release of ANSYS Fluent and reverts to the arguments of the release that you
specify using the command (within two full releases of the current release). The command is automatically
added to a journal file as soon as you start the recording.
show-configuration
Displays current release and version information.
single-precision-coordinates?
Specifies whether the nodal coordinates should be written in single precision (rather than the default
double precision). This text command is only available in the single-precision version of ANSYS Fluent.
solution-files/
Enters the solution files menu.
delete-solution
Deletes solution files.
load-solution
Loads a solution file.
print-solution-files
Prints a list of available solution files.
file/
start-journal
Starts recording all input in a file. Note that commands entered using paths from older versions of Fluent
will be upgraded to their current path in the journal file.
start-transcript
Starts recording input and output in a file.
stop-journal
Stops recording input and closes journal file.
stop-macro
Stops recording input to a macro.
stop-transcript
Stops recording input and output and closes transcript file.
sync-workbench
Directly updates Workbench with the most recent Fluent changes. This command is only available when
running ANSYS Fluent in Workbench.
transient-export/
abaqus
Writes an ABAQUS file.
ascii
Writes an ASCII file.
avs
Writes an AVS UCD file.
cdat-for-cfd-post-&-ensight
Writes data files that are compatible with CFD-Post and EnSight (that is, .cdat and .cst files).
cgns
Writes a CGNS file.
dx
Writes an IBM Data Explorer format file.
ensight-gold-transient
Writes EnSight Gold geometry, velocity, and scalar files.
ensight-gold-from-existing-files
Writes EnSight Gold files using ANSYS Fluent case files.
ensight-gold-parallel-surfaces
Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for
EnSight Enterprise.
ensight-gold-parallel-volume
Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for
EnSight Enterprise.
fast
Writes a FAST/Plot3D unstructured mesh velocity scalar file.
fast-solution
Writes a FAST/Plot3D unstructured solution file.
fieldview-unstruct
Writes a FIELDVIEW unstructured combined file.
fieldview-unstruct-mesh
Writes a FIELDVIEW unstructured mesh only file.
fieldview-unstruct-data
Writes a FIELDVIEW unstructured results only file.
fieldview-unstruct-surfaces
Writes FIELDVIEW unstructured combined file for surfaces.
ideas
Writes an I-deas universal file.
mechanical-apdl-input
Writes a Mechanical APDL input file.
nastran
Writes a NASTRAN file.
patran-neutral
Writes a PATRAN neutral file.
taitherm
Writes a TAITherm file.
particle-history-data
Sets up an automatic particle-history data export.
edit
Edits transient exports.
delete
Deletes transient exports.
settings/
Enters the automatic export settings menu.
cfd-post-compatible
Specifies when case files are written with the .cdat and .cst files exported for ANSYS CFD-Post.
Note that this setting is ignored if the Write Case File Every Time option is enabled in the Auto-
matic Export dialog box.
write-boundary-mesh
Writes the boundary mesh to a file.
write-case
Writes a case file.
file/
write-case-data
Writes a case and a data file.
write-cleanup-script
Writes the cleanup-script-file for ANSYS Fluent.
write-data
Writes a data file.
write-fan-profile
Computes radial profiles for a fan zone and writes them to a profile file.
write-field-functions
Writes the currently defined custom field functions to a file.
write-flamelet
Writes a flamelet file.
write-injections
Writes out selected DPM injections to a file.
write-isat-table
Writes ISAT Table.
write-macros
Writes the currently defined macros to a file.
write-merge-profiles
Writes a .csv file with the selected surfaces consolidated into one set of data points.
write-pdat?
Enables / disables the attempt to save .pdat files. Note that this text command is no longer supported.
write-pdf
Writes a pdf file.
write-profile
Writes surface data as a boundary profile file.
write-settings
Writes out current boundary conditions in use.
write-surface-clusters/
Writes the surface clusters to a file.
set-parameters
Sets the parameters needed for the view factor calculations.
split-angle
Sets the split angle for the clustering algorithm.
write-surface-clusters
Computes and writes surface clusters for S2S radiation model.
Chapter 7: mesh/
adapt/
Enters the mesh adaption menu.
adapt-mesh
Adapts the mesh according to the methods and settings that you specified.
anisotropic-adaption
Anisotropically refines boundary layers. Cells will be split in the normal direction to the boundary face.
cell-registers/
Enters the cell registers menu.
add
Creates a new cell register.
apply-poor-mesh-numerics
Applies poor mesh numerics to the mesh of a cell register.
coarsen
Coarsen the mesh based on a cell register.
delete
Deletes a cell register.
display
Displays a cell register.
edit
Edits an existing cell register.
list
Lists all of the currently defined cell registers.
list-properties
Lists the properties of a cell register.
refine
Refine the mesh based on a cell register.
coarsening-criteria
Allows you to provide an expression for the coarsening criterion.
predefined-criteria/
Enters the predefined-criteria menu, which allows you to select commonly used criteria for adapting
the mesh.
mesh/
multiphase/
Enters the multiphase menu, which provides text commands that create cell registers and define
adaption controls that can be useful for Volume of Fluid (VOF) simulations.
vof
Creates cell registers and defines adaption settings that are suitable for standard Volume of
Fluid (VOF) simulations.
vof-to-dpm-advanced
Creates cell registers and defines adaption settings that are suitable when using the VOF-to-
DPM model transition mechanism; the resulting adaption controls will be defined by complex
expressions that draw upon cell registers, as well as parameters that you will need to define.
vof-to-dpm-generic
Creates cell registers and defines adaption settings that are suitable when using the VOF-to-
DPM model transition mechanism; the resulting adaption controls will be defined by fairly
straightforward cell registers.
display-adaption-cells
Displays the cells that are marked for adaption in the graphics window.
free-hierarchy
Deletes the defined adaption hierarchy.
geometry
Enters the geometry menu.
reconstruct-geometry
Enables/disables geometry-based adaption.
set-geometry-controls
Sets geometry controls for wall zones.
list-adaption-cells
Prints the number of cells marked for refinement, coarsening, and both to the console.
refinement-criteria
Allows you to provide an expression for the refinement criterion.
revert-to-R19.2-user-interface
Reverts the user interface, specifically the Adapt group box of the Domain ribbon tab to contain the
same adaption register options as were available with ANSYS Fluent release 19.2. Note that you cannot
"undo" this command once you enter it.
set/
Enters the set menu.
additional-refinement-layers
Allows you to specify additional refinement layers (this is an advanced control).
cell-zones
Sets cell zones to be used for marking adaption. An empty list specifies that all zones are considered
for adaption.
display-settings
Sets the graphics display options for the refinement, coarsening, and common cells.
dynamic-adaption?
Enables automatic mesh adaption during the calculation, based on your specified refinement and
coarsening settings.
dynamic-adaption-frequency
Specifies the interval for how many iterations or time steps must pass between two consecutive
automatic mesh adaptions.
maximum-refinement-level
Controls the number of levels of refinement used to split cells during the adaption.
method
Sets the adaption method.
minimum-cell-quality
Sets the minimum value allowed for the orthogonal quality of cells during adaption. If your solution
diverges, you may find that using a higher minimum quality value resolves the issue. This text
command is only available with the PUMA 3D adaption method.
minimum-cell-volume
Restricts the size of cell that Fluent considers for refinement. Even if the cell is marked for refinement,
it will not be refined if its cell volume is less than this threshold value.
verbosity
Allows you set how much information about the adaption is printed to the console.
adjacency
Views and renames face zones adjacent to selected cell zones.
check
Performs various mesh consistency checks and displays a report in the console that lists the domain extents,
the volume statistics, the face area statistics, and any warnings, as well as details about the various checks
and mesh failures (depending on the setting specified for mesh/check-verbosity).
check-verbosity
Sets the level of details that will be added to the mesh check report generated by mesh/check. A value
of 0 (the default) notes when checks are being performed, but does not list them individually. A value of
1 lists the individual checks as they are performed. A value of 2 lists the individual checks as they are per-
formed, and provides additional details (for example, the location of the problem, the affected cells).
The check-verbosity text command can also be used to set the level of detail displayed in the
mesh quality report generated by mesh/quality. A value of 0 (the default) or 1 lists the minimum
orthogonal quality and the maximum aspect ratio. A value of 2 adds information about the zones
that contain the cells with the lowest quality, and additional metrics such as the maximum cell
squish index and the minimum expansion ratio.
memory-usage
Reports solver memory use.
mesh-info
Prints zone information size.
mesh/
modify-zones/
Enters the zone modification menu. For a description of the items in this menu, see define/boundary-
conditions/modify-zones.
polyhedra/
Enters the polyhedra menu.
convert-domain
Converts the entire domain to polyhedra cells.
convert-hanging-nodes
Converts cells with hanging nodes/edges to polyhedra.
convert-skewed-cells
Converts skewed cells to polyhedra.
options/
Enters the polyhedra options menu.
migrate-and-reorder?
Enables / disables the migration of newly created partitions to the compute-nodes and the reorder-
ing of the domain as part of polyhedra conversion. This is disabled by default, because it requires
significant additional memory; when disabled, it is recommended that you save the case file after
conversion, read it in a new Fluent session (so that the new / stored partitions become active), and
then manually reorder using the mesh/reorder/reorder-domain text command. If you want
to run the calculation in the current Fluent session you can enable the migrate-and-reorder?
text command prior to conversion, but you must ensure that no more than half of the available
memory of your system is currently used.
preserve-boundary-layer?
Specifies whether boundary layer cells will be preserved when the domain is converted to polyhedra.
When the value is set to 0 (default) ANSYS Fluent checks for high aspect ratio cells at the boundary
layer and if any are found, Fluent asks if you want to preserve the boundary layer. When the value
is set to 1, the boundary layer cells are never preserved; when it is set to 2, the boundary layer cells
are always preserved (regardless of the aspect ratio of the boundary layer cells).
preserve-interior-zones
Enables the preservation of surfaces (that is, manifold zones of type interior) during the conversion
of the domain to polyhedra. Note that only those zones with a name that includes the string you
specify will be preserved.
quality
Displays information about the quality of the mesh in the console, including the minimum orthogonal
quality and the maximum aspect ratio. The level of detail displayed depends on the setting specified for
mesh/check-verbosity.
redistribute-boundary-layer
Redistributes the nodes in a boundary layer zone to achieve a desired growth rate after anisotropic adaption.
reorder/
Reorders domain menu.
band-width
Prints cell bandwidth.
reorder-domain
Reorders cells and faces using the reverse Cuthill-McKee algorithm. Note that you must save a new
case file (and a data file, if data exists) after reordering with this text command, as well as recreate any
ray files and/or surface cluster information.
reorder-zones
Reorders zones by partition, type, and ID.
repair-improve
allow-repair-at-boundaries
Allows the adjustment of the positions of nodes on boundaries as part of the mesh repairs performed
by the mesh/repair-improve/repair text command.
improve-quality
Improves poor quality cells in the mesh, if possible.
include-local-polyhedra-conversion-in-repair
Enables/disables the local conversion of degenerate cells into polyhedra based on skewness criteria
as part of the mesh repairs performed by the mesh/repair-improve/repair text command.
repair
Repairs mesh problems identified by the mesh check, if possible. The repairs include fixing cells that
have the wrong node order, the wrong face handedness, faces that are small or nonexistent, or very
poor quality. Only interior nodes are repositioned by default; boundary nodes may be repositioned if
the mesh/repair-improve/allow-repair-at-boundaries text command is enabled. Note
that highly skewed cells may be converted into polyhedra, depending on whether the mesh/repair-
improve/include-local-polyhedra-conversion-in-repair text command is enabled.
repair-face-handedness
Modifies cell centroids to repair meshes that contain left-handed faces without face node order prob-
lems.
repair-face-node-order
Modifies face nodes to repair faces with improper face node order and, therefore, eliminates any res-
ulting left-handed faces.
repair-periodic
Modifies the mesh to enforce a rotational angle or translational distance for periodic boundaries. For
translationally periodic boundaries, the command computes an average translation distance and adjusts
the node coordinates on the shadow face zone to match this distance. For rotationally periodic
boundaries, the command prompts for an angle and adjusts the node coordinates on the shadow face
zone using this angle and the defined rotational axis for the cell zone.
repair-wall-distance
Corrects wall distance at very high aspect ratio hexahedral/polyhedral cells.
report-poor-elements
Reports invalid and poor quality elements.
rotate
Rotates the mesh.
mesh/
scale
Prompts for the scaling factors in each of the active Cartesian coordinate directions.
size-info
Prints mesh size.
smooth-mesh
Smooths the mesh using quality-based, Laplacian, or skewness methods.
surface-mesh/
Enters the Surface Mesh menu.
delete
Deletes surface mesh.
display
Displays surface meshes.
read
Reads surface meshes.
swap-mesh-faces
Swaps mesh faces.
translate
Prompts for the translation offset in each of the active Cartesian coordinate directions.
Chapter 8: parallel/
bandwidth
Shows network bandwidth.
check
Performs checks of various factors that affect parallel performance.
check
Sets verbosity output of the parallel check. Higher verbosity corresponds to more detailed information.
gpgpu/
Enters the GPGPU menu
select
Selects which GPGPUs to use for AMG acceleration
show
Lists the available GPGPUs. GPGPUs selected for use are indicated by the presence of an asterisk (*).
latency
Shows network latency.
load-balance
Enters the load balancing parameters menu.
physical-models
Uses physical-models load balancing?
dynamic-mesh
Uses load balancing for dynamic mesh?
mesh-adaption
Uses load balancing for mesh adaption?
partition/
Enters the partition domain menu.
auto/
Sets auto partition parameters.
across-zones
Enables auto partitioning by zone or by domain.
load-vector
Sets the auto partition load vector.
method
Sets the partition method.
parallel/
pre-test
Sets auto partition pre-testing optimization.
use-case-file-method
Uses partitions in a pre-partitioned case file.
combine-partition
Merges every N partitions.
merge-clusters
Calls the optimizer that attempts to decrease the number of interfaces by eliminating orphan cell
clusters. (An orphan cluster is a group of connected cells such that each member has at least one face
that is part of an interface boundary.)
method
Sets the partition method.
print-active-partitions
Prints active partition information (parallel solver).
print-stored-partitions
Prints stored partition information (parallel solver).
reorder-partitions
Reorders partitions.
reorder-partitions-to-architecture
Reorders partitions to architecture.
set/
Enters the set partition parameters menu.
across-zones
Allows partitions to cross zone boundaries (the default). If turned off, it will restrict partitioning to
within each cell zone. This is recommended only when cells in different zones require significantly
different amounts of computation during the solution phase; for example, if the domain contains
both solid and fluid zones.
all-off
Disables all optimizations.
all-on
Enables all optimizations.
cell-function
Sets cell function.
dpm-load-balancing
Enables / disables dynamic load balancing for discrete phase model cases that use a second domain
for DPM particle tracking (that is, cases for which you have enabled the define/models/dpm/par-
allel/hybrid-2domain? text command).
face-area-as-weights
Uses face area as connection weights.
isat-weight
Sets ISAT weight.
laplace-smoothing
Enables the Laplace smoothing option which can prevent partition boundaries from lying along
regions of high aspect ratio cells.
load-distribution
Sets the number of cells desired for each partition. This is useful, for example, when computing
on multiple machines with significantly different performance characteristics. If left unset, each
partition will contain an approximately equal number of cells. Normalized relative values may be
used for the entries.
merge
Toggles the optimizer that attempts to decrease the number of interfaces by eliminating orphan
cell clusters.
model-weighted-partition
Enables / disables model-weighted partitioning. This option works with the METIS partitioning
method, and specifies that Fluent automatically calculates the weighting based on the cell count
and the models and attributes specified as weights (using the parallel/parti-
tion/set/isat-weight text command, for example).
nfaces-as-weights
Uses number of faces as weights.
origin
Sets the , , and coordinate of the origin used by those partitioning functions that require a
radial distance. By default, the origin is set to (0, 0, 0).
particle-weight
Sets DPM particle weight.
pre-test
Enables the operation that determines the best coordinate-splitting direction.
solid-thread-weight
Uses solid thread weights.
smooth
Toggles the optimizer that attempts to minimize the number of interfaces by modifying the partition
boundaries to reduce surface area.
verbosity
Controls the amount of information that is printed out during partitioning. If set to 1 (the default),
a text character . is displayed during each bisection, and partition statistics are displayed once
the partitioning completes. If set to 2, additional information about the bisection operation is dis-
played during each bisection. If set to 0, partition statistics and information during each bisection
are not displayed.
vof-free-surface-weight
Sets VOF free surface weight.
parallel/
smooth-partition
Calls the optimizer that attempts to minimize the number of interfaces by modifying the partition
boundaries to reduce surface area.
use-stored-partitions
Uses this partitioning.
set/
Enters the set parallel parameters menu.
fast-i/o?
Uses the fast I/O option.
partition-mask
Sets partition mask.
time-out
Sets spawn time-out in seconds.
verbosity
Sets the parallel verbosity.
show-connectivity
Prints the network connectivity for the selected compute node.
thread-number-control
Sets the maximum number of threads on each machine.
timer/
Enters the timer menu.
usage
Prints performance statistics in the console window.
reset
Adjusts domain timers.
Chapter 9: plot/
circum-avg-axial
Computes iso-axial band surfaces and plots data vs. axial coordinate on them.
circum-avg-radial
Computes iso-radial band surfaces and plots data vs. radius on them.
change-fft-ref-pressure
Changes reference acoustic pressure.
cumulative-plot/
Plot the development of force, force coefficient, moment, or moment coefficient across the specified wall
zones.
force-or-moment-setup
Setup the cumulative force or moment plot.
plot
Plot the defined cumulative plot in the graphics window.
print
Print the value of the plot to the console.
write
Write the cumulative plot to a file.
display-profile-data
Plots profile data.
fft
Plots FFT of file data.
file
Plots data from an external file.
file-list
Plots data from multiple external files.
file-set/
Sets file plot parameters.
auto-scale?
Sets the range for the and axes. If auto-scaling is not activated for a particular axis, you are
prompted for the minimum and maximum data values.
background-color
Sets the color of the field within the abscissa and ordinate axes.
plot/
key
Enables/disables display of curve key and sets its window title.
file-lines
Sets parameters for plot lines.
file-markers
Sets parameters for data markers.
labels
Sets labels for plot axes.
lines
Sets parameters for plot lines.
log?
Uses log scales for one or both axes.
markers
Sets parameters for data markers.
numbers
Sets number formats for axes.
plot-to-file
Specifies a file in which to write XY plot data.
rules
Sets parameters for display of major and minor rules.
windows/
XY plot window options. For a description of the items in this menu, see display/set/windows/xy.
flamelet-curves/
Enters the flamelet curves menu.
plot-curves
Plots of a curve property.
write-to-file?
Writes curve to a file instead of plot.
histogram
Plots a histogram of the specified solution variable using the defined range and number of intervals.
histogram-set/
Sets histogram plot parameters. Sub-menu items are the same as file-set/ above.
label-alignment
Set the orientation of XY plot axis labels as either horizontal or axis-aligned.
datasources/
Enters the menu for creating and modifying plots containing multiple data sources.
add-report-plot
Specify an existing report plot to include in this plot.
add-xy-plot
Specify an existing XY plot to include in this plot.
list-curve-information
Prints the names of the variables selected for plotting.
list-data-sources
Prints the names of the selected/loaded data sources including the files and in-session plot objects.
list-legend-names
Prints the names of the legends to the console.
load-file
Specify a file to load for plotting. The file must be located in the working directory.
plot
Plots the selected data in the active graphics window.
properties
Prints the properties of whichever plot or file included in the multiple data sources plot that you specify.
remove-data-source
Removes whichever data source (plot or file) you specify.
rename-legend
Allows you to rename legend entries. Note that you must re-plot to see the legend name change.
plot
Plots solution on surfaces.
plot-direction
Sets plot direction for XY plot.
residuals
Contains commands that allow you to select the variables for which you want to display XY plots of residual
histories in the active graphics window.
residuals-set/
Sets residual plot parameters. Sub-menu items are the same as file-set/ above.
solution
Plots solution on surfaces and/or zones. Zone and surface names can be indicated using a wildcard (*).
solution-set/
Sets solution plot parameters. Sub-menu items are the same as file-set/ above.
label-alignment
Sets the alignment of the xy plot label to be horizontal or axis aligned.
Chapter 10: report/
dpm-extended-summary
Create an extended discrete phase summary report of the discrete phase injection(s). You can choose
whether you want to save the extended report to a file or print it in the console window. For unsteady
tracking, you will be asked whether you want to include in-domain particle/tracks in the report. You will
be also prompted whether you want to select a single injection for the summary report. By default, all in-
jections are included. The output depends on whether you have enabled the report/dpm-zone-
summaries-per-injection? text command, in which case additional information is printed for escaped
particles, such as per-injection data. Note that, for unsteady particle tracking, it is necessary to enable the
report/dpm-zone-summaries-per-injection? text command before any particle parcels are
injected into the domain.
dpm-histogram/
Enters the DPM histogram menu.
compute-sample
Computes the minimum/maximum of a sample variable.
delete-sample
Deletes a sample from the loaded sample list.
list-samples
Shows all samples in a loaded sample list.
pick-sample-to-reduce
Select a sample to be reduced.
plot-sample
Plots a histogram of a loaded sample.
read-sample
Reads a sample file and adds it to the sample list.
reduce-picked-sample
Reduce a sample as specified by the data reduction parameters. This command is available only after
you selected the sample using the pick-sample-to-reduce text command.
set/
Enters the settings menu for the histogram.
auto-range?
Automatically computes the range of the sampling variable for histogram plots.
correlation?
Computes the correlation of the sampling variable with another variable.
report/
cumulation-curve?
Computes a cumulative curve for the sampling variable or correlation variable when correla-
tion? is specified.
diameter-statistics?
Computes the Rosin Rammler parameters, Sauter, and other mean diameters.
histogram-mode?
Uses bars for the histogram plot or xy-style.
logarithmic?
Enables/disables the use of logarithmic scaling on the abscissa of the histogram.
maximum
Specifies the maximum value of the x-axis variable for histogram plots.
minimum
Specifies the minimum value of the x-axis variable for histogram plots.
number-of-bins
Specifies the number of bins.
percentage?
Uses percentages of bins to be computed.
variable^3?
Uses the cubic of the cumulation variable during computation of the cumulative curve.
weighting?
Uses weighting with additional variables when sorting data into samples.
write-sample
Writes a histogram of a loaded sample into a file.
setup-reduction/
Enters the settings menu for the sample data reduction. This command is available only after you se-
lected the sample using the pick-sample-to-reduce text command.
all-variables-number-of-bins
Sets the number of bins to be used for all variables in the data reduction.
list-settings
Prints all current sample data reduction settings for all variables in the selected sample in the
console.
logarithmic?
Enables/disables the logarithmic scaling for a selected variable.
make-steady-from-unsteady-file?
Enables/disables the unsteady sample reduction into a steady-state injection file. This command
is available only for sample files from unsteady particle tracking.
maximum
Sets the maximum value of the range to be considered for a specific variable.
minimum
Sets the minimum value of the range to be considered for a specific variable.
number-of-bins
Sets the number of bins for a specific variable.
reset-min-and-max
Resets the specified maximum and minimum values for a specific variable.
use-weighting?
Enables/disables the use of weighting in the data averaging in each bin.
weighting-variable
Sets the weighting variable for the data averaging in each bin.
dpm-sample
Samples trajectories at boundaries and lines/planes.
dpm-sample-output-udf
Allows you to hook a previously loaded DEFINE_DPM_OUTPUT UDF for file format specification for
sampling of trajectories and VOF-to-DPM lump conversion transcripts.
dpm-sample-sort-file?
Enables/disables writing of sorted DPM sample files.
dpm-summary
Prints discrete phase summary report.
dpm-zone-summaries-per-injection?
Enables/disables calculation of the escaped mass per injection. Note that for unsteady particle tracking, if
you want to report the mass of escaped particles per injection, this text command must be enabled before
any particles are injected into the domain.
element-mass-flow
Prints list of element flow rate at inlets and outlets. This reports the mass flow rates of all chemical elements
(in kg/s) flowing through the simulation boundaries.
fluxes/
Enters the fluxes menu.
film-heat-transfer
Prints wall film heat transfer rate at boundaries. This text command is only available when you enable
the Eulerian wall film model.
film-mass-flow
Prints wall film mass flow rate at boundaries. This text command is only available when you enable
the Eulerian wall film model.
heat-transfer
Prints heat transfer rate at boundaries.
heat-transfer-sensible
Prints the sensible heat transfer rate at the boundaries.
report/
mass-flow
Prints mass flow rate at inlets and outlets.
rad-heat-trans
Prints radiation heat transfer rate at boundaries.
forces/
Enters the forces menu.
pressure-center
Prints the center of pressure on wall zones.
wall-forces
Computes the forces along the specified force vector for all wall zones.
wall-moments
Computes the moments about the specified moment center for all wall zones.
heat-exchanger/
Enters the heat exchanger menu.
computed-heat-rejection
Prints total heat rejection.
inlet-temperature
Prints inlet temperature.
outlet-temperature
Prints outlet temperature.
mass-flow-rate
Prints mass flow rate.
specific-heat
Prints fluid’s specific heat.
mphase-summary
Prints summary report for a multiphase case setup.
particle-summary
Prints summary report for all current particles.
path-line-summary
Prints pathline summary report.
print-histogram
Prints a histogram of a scalar quantity.
projected-surface-area
Computes the area of the projection of selected surfaces along the , , or axis.
reference-values/
Enters the reference value menu.
area
Sets reference area for normalization.
compute/
Computes reference values from zone boundary conditions.
density
Sets reference density for normalization.
depth
Sets reference depth for volume calculation.
enthalpy
Sets reference enthalpy for enthalpy damping and normalization.
length
Sets reference length for normalization.
list
Lists current reference values.
pressure
Sets reference pressure for normalization.
temperature
Sets reference temperature for normalization.
velocity
Sets reference velocity for normalization.
viscosity
Sets reference viscosity for normalization.
zone
Sets reference zone.
species-mass-flow
Prints list of species mass flow rate at inlets and outlets. This reports the mass flow rates of all species (in
kg/s) flowing through the simulation boundaries.
summary
Prints the current settings for physical models, boundary conditions, material properties, and solution
parameters.
surface-integrals/
Enters the surface integral menu.
area
Prints the area of the selected surfaces.
area-weighted-average
Prints area-weighted average of the specified quantity over the selected surfaces.
facet-avg
Prints the facet average of the specified quantity over the selected surfaces.
report/
facet-max
Prints the maximum of the specified quantity over facet centroids of the selected surfaces.
facet-min
Prints the minimum of the specified quantity over facet centroids of the selected surfaces.
flow-rate
Prints the flow rate of the specified quantity over the selected surfaces.
integral
Prints the integral of the specified quantity over the selected surfaces. You can include a wildcard (*)
within the surface names.
mass-flow-rate
Prints the mass flow rate through the selected surfaces.
mass-weighted-avg
Prints the mass-averaged quantity over the selected surfaces.
standard-deviation
Prints the standard deviation of the scalar at the facet centroids of the surface.
sum
Prints sum of scalar at facet centroids of the surfaces.
uniformity-index-area-weighted
Prints the area-weighted uniformity index of the specified quantity over the selected surfaces.
uniformity-index-mass-weighted
Prints the mass-weighted uniformity index of the specified quantity over the selected surfaces.
vector-based-flux
Prints the vector-based flux of the specified quantity over the selected surfaces.
vector-flux
Prints the vector flux over the selected surfaces.
vector-weighted-average
Prints the vector-averaged quantity over the selected surfaces.
vertex-avg
Prints the vertex average of the specified quantity over the selected surfaces.
vertex-max
Prints the maximum of the specified quantity over vertices of the selected surfaces.
vertex-min
Prints the minimum of the specified quantity over vertices of the selected surfaces.
volume-flow-rate
Prints the volume flow rate through the selected surfaces.
system/
Enters the system menu.
gpgpu-stats
Prints information about installed general purpose graphical processing units.
proc-stats
Prints ANSYS Fluent process information. This is used to report the memory usage of each of the ANSYS
Fluent processes.
sys-stats
System information. This is used to report the CPU configuration of the machines where ANSYS Fluent
processes have been spawned.
time-stats
Timer information. This is used to report CPU timings for user and kernel processes and detailed solver
timings.
uds-flow
Prints list of user-defined scalar flow rate at boundaries.
volume-integrals/
Enters the volume integral menu.
mass
Prints total mass of a phase within a selected cell zone.
mass-avg
Prints mass-average of scalar over cell zones.
mass-integral
Prints mass-weighted integral of scalar over cell zones.
maximum
Prints maximum of scalar over all cell zones.
minimum
Prints minimum of scalar over all cell zones.
sum
Prints sum of scalar over all cell zones.
twopisum
Prints sum of scalar over all cell zones multiplied by 2π.
volume
Prints total volume of specified cell zones.
volume-avg
Prints volume-weighted average of scalar over cell zones.
volume-integral
Prints integral of scalar over cell zones.
Chapter 11: server/
start-client
Start the ANSYS Fluent remote visualization client.
start-server
Starts the server for the ANSYS Fluent remote visualization client.
print-connected-clients
Prints the name of the connected client and its IP address to the console.
print-server-address
Prints the host address and port number of the server to the console.
shutdown-server
Shuts-down the server and disconnects the connected client.
write-or-reset-server-info
Allows you to create a new server_info.txt file (with any name you specify), which resets the password
for connecting to this server session. It does not restart the server.
Chapter 12: solve/
animate/
Enters the animation menu.
define/
Enters the animation definition menu.
define-monitor
Defines new animation.
edit-monitor
Changes animation monitor attributes.
objects/
Enters the object manipulation menu.
clear-history
Clears solution animation object history.
copy
Copies solution animation object.
create
Creates new solution animation object.
delete
Deletes solution animation object.
edit
Edits solution animation object.
playback/
Enters the animation playback menu.
delete
Deletes animation sequence.
play
Plays the selected animation.
read
Reads new animation from file or already defined animations.
stored-view?
Plays the 3D animation sequence using the view stored in the sequence.
write
Writes animation sequence to the file.
solve/
cell-register-operations/
Enters the cell register operations menu.
add
Creates a new cell register operation.
delete
Deletes a cell register operation.
edit
Edits an existing cell register operation.
list
Lists the currently defined cell register operations.
list-properties
Lists the properties of a report register operation.
cell-registers/
Enters the cell registers menu.
add
Creates a new cell register.
apply-poor-mesh-numerics
Applies poor mesh numerics to the mesh of a cell register.
coarsen
Coarsen the mesh based on a cell register.
delete
Deletes a cell register.
display
Displays a cell register.
edit
Edits an existing cell register.
list
Lists all of the currently defined cell registers.
list-properties
Lists the properties of a cell register.
refine
Refine the mesh based on a cell register.
convergence-conditions/
Enters the convergence conditions menu.
condition
Specifies whether the solution is considered converged when all of the conditions are met or when
one of the conditions is met.
conv-reports/
Enters the convergence reports menu.
add
Creates a new convergence condition.
delete
Deletes a convergence condition.
edit
Edits a convergence condition.
list
Lists all of the report definition-based convergence conditions.
list-properties
Lists the properties of the specified convergence condition.
frequency
Specifies how often convergence checks are performed.
dpm-update
Updates discrete phase source terms.
dual-time-iterate
Performs unsteady iterations for a specified number of time steps.
execute-commands/
Enters the execute commands menu.
add-edit
Adds or edits execute commands.
disable
Disables an execute command.
enable
Enables an execute command.
initialize/
Enters the flow initialization menu.
compute-defaults/
Enters the compute default values menu.
all-zones
Initializes the flow field with the default values.
zone
You can select the type of zone from which you want to compute these values. The types of zones
available are:
• axis
• degassing
solve/
• exhaust-fan
• fan
• fluid
• inlet-vent
• intake-fan
• interface
• interior
• mass-flow-inlet
• mass-flow-outlet
• network
• network-end
• outflow
• outlet-vent
• periodic
• porous-jump
• pressure-far-field
• pressure-inlet
• pressure-outlet
• radiator
• rans-les-interface
• recirculation-inlet
• recirculation-outlet
• shadow
• solid
• symmetry
• velocity-inlet
• wall
dpm-reset
Resets discrete phase source terms to zero.
fmg-initialization
Initializes using the full-multigrid initialization (FMG).
hyb-initialization
Initializes using the hybrid initialization method.
init-acoustics-options
Specifies the number of timesteps for ramping of sound sources and re-initializes the acoustics wave
equation solution. For the initialized acoustics solution, Fluent reports the current state of the sound
sources ramping.
init-flow-statistics
Initializes unsteady statistics.
initialize-flow
Initializes the flow field with the current default values.
lwf-initialization
Deletes wall film particles and initializes wall film variables to zero. This option is available only with
the wall-film DPM boundary condition.
init-turb-vel-fluctuations
Initializes instantaneous velocity field out of steady state RANS results, for use before enabling a scale
resolving simulation such as LES.
list-defaults
Lists default values.
open-channel-auto-init
Opens channel automatic initialization.
reference-frame
Sets reference frame to absolute or relative.
repair-wall-distance
Corrects wall distance at very high aspect ratio hexahedral/polyhedral cells.
set-defaults/
Sets default initial values.
set-fmg-initialization/
Enters the set full-multigrid for initialization menu. Initial values for each variable can be set within this
menu.
set-hyb-initialization/
Enters the hybrid initialization menu.
general-settings
Enters the general settings menu.
turbulence-settings
Enters the turbulence settings menu.
species-settings
Enters the species-settings menu.
solve/
show-iterations-sampled
Displays the number of iterations covered by the data sampled for steady statistics.
show-time-sampled
Displays the amount of simulated time covered by the data sampled for unsteady statistics.
vof-patch-smooth-options/
Enters the vof patch/smooth options menu.
execute-smoothing
Performs volumetric smoothing for volume fraction.
set-options
Sets options for patching and smoothing volume fraction.
iterate
Performs a specified number of iterations.
Note:
This option is still available during transient simulations, since it can be used to add more
iterations to the same time step after interrupting iterations within a time step.
mesh-motion
Performs mesh motion.
monitors/
Sets solution monitors.
residual/
Enters the residual monitors menu.
check-convergence?
Chooses which currently monitored residuals should be checked for convergence.
Sets convergence criteria for residuals that are currently being both monitored and checked.
criterion-type
Sets convergence criterion type.
monitor?
Chooses which residuals to monitor as printed and/or plotted output.
n-display
Sets the number of most recent residuals to display in plots.
n-maximize-norms
Sets the number of iterations through which normalization factors will be maximized.
normalization-factors
Sets normalization factors for currently monitored residuals (if normalize? is set to yes).
normalize?
Chooses whether to normalize residuals in printed and plotted output.
n-save
Sets number of residuals to be saved with data. History is automatically compacted when buffer
becomes full.
plot?
Chooses whether residuals will be plotted during iteration.
print?
Chooses whether residuals will be printed during iteration.
relative-conv-criteria
Sets relative convergence criteria for residuals that are currently being both monitored and checked.
re-normalize
Re-normalize residuals by maximum values.
reset?
Chooses whether to delete the residual history and reset iteration counter to 1.
scale-by-coefficient?
Chooses whether to scale residuals by coefficient sum in printed and plotted output.
window
Specifies window in which residuals will be plotted during iteration.
patch
Patches a value for a flow variable in the domain.
report-definitions/
Enters the report definitions menu.
add
Creates a report definition.
copy
Creates a copy of a report definition.
delete
Deletes a report definition.
delete-all
Deletes all of the report definition objects.
edit
Edits a report definition.
list
Lists all defined report definitions.
list-properties
Lists the properties of a report definition.
solve/
rename
Renames a report definition.
report-files/
Enters the report files menu.
add
Creates a report file.
clear-data
Clears the data associated with a report file.
delete
Deletes a report file object.
delete-all
Deletes all of the report file objects.
edit
Edits a report file.
list
Lists all defined report files.
list-properties
Lists the properties of a report file.
report-plots/
Enters the report plots menu.
add
Creates a report plot.
axes
Defines the axes for a report plot.
clear-data
Clears the data associated with a report plot.
curves
Defines the curves for a report plot.
delete
Deletes a report plot object.
delete-all
Deletes all of the report plot objects.
edit
Edits a report plot.
list
Lists all defined report plots.
list-properties
Lists the properties of a report plot.
plot
Plots the specified report plot.
rombuilder/
Enters the rombuilder menu.
enable?
Enables/disables the reduced order model.
evaluate
Allows you to enter values between the allowed ranges for the existing variables and zones that are
part of the loaded ROM and have the results computed (when a ROMZ file is loaded into Fluent in
Workbench).
select-variables-and-zones
Select the variables and locations that you want included in the reduced order model.
set/
Enters the set solution parameters menu.
accelerated-non-iterative-time-marching
Enables a modified NITA scheme and other setting changes that can speed up the simulation. This
option is only available with the Large Eddy Simulation (LES) turbulence model, and is intended for
unreacting flow simulations that use a constant-density fluid.
acoustics-wave-equation-controls/
Enters the menu to specify parameters of the acoustics wave equation solver.
expert/
Enters the menu to specify the expert parameters.
explicit-relaxation-factor
Specifies the explicit relaxation factor. Should be used only with bad meshes, when iterations
do not converge.
under-relaxation-factor
Specifies the implicit under-relaxation factor. Should be used only with bad meshes, when the
AMG linear solver does not converge.
max-iterations-per-timestep
Specifies the maximum number if iterations, which will be performed by the acoustics wave
equation solver in one timestep.
relative-convergence-criterion
Specifies the iterations convergence criterion in terms of the residual norm drop.
amg-options/
Enters the AMG options menu
aggressive-amg-coarsening?
Enables / disables the use of a version of the AMG solver that is optimized for high coarsening
rates. This option is recommended if the AMG solver diverges with the default settings.
solve/
amg-gpgpu-options/
Enters the AMG GPGPU options menu, which contains commands to enable / disable GPGPU ac-
celeration and set solver type and options for individual coupled and scalar equations.
conservative-amg-coarsening?
Enables / disables the use of conservative coarsening techniques for scalar and/or coupled equations
that can improve parallel performance and/or convergence for some difficult cases.
laplace-coarsening?
Enables / disables Laplace coarsening for scalar and/or coupled equations.
bc-pressure-extrapolations
Sets pressure extrapolations schemes on boundaries.
If you are using the density-based solver, you will be asked the following questions:
extrapolate total quantities on pressure-outlet boundaries?

The default is [no]. If you enter yes, and the flow leaving the pressure outlet is subsonic, then
the total pressure and total temperature from the domain’s interior are extrapolated to the
boundary and used with the imposed static pressure to determine the full thermodynamic state
at the boundary.
extrapolate pressure on pressure-inlet boundary?

The default is [no]. If you enter yes, then for cases with very low Mach number flow in the single-
precision density-based solver, you can improve convergence by using pressure extrapolation in-
stead of the default velocity extrapolation scheme.
pressure on pressure-outlet b.c. is obtained via an advection splitting

method?
The default is [yes]. If you choose the default, this means that the pressure-outlet boundary
condition implementation in the density-based solver has an absorption behavior, as described
in Calculation Procedure at Pressure Outlet Boundaries of the User’s Guide. To revert to pre-ANSYS
Fluent 6.3 boundary condition implementations, where the pressure on the faces of a pressure-
outlet boundary is fixed to the specified value while the flow is subsonic, enter no.
Important:
The absorption behavior of the pressure-outlet boundary condition should not

be confused with rigorous non-reflecting boundary condition implementation,
described in Boundary Acoustic Wave Models of the User’s Guide.
If you are using the pressure-based solver, you will be asked the following questions:
extrapolate pressure on flow inlets?

The default is [yes].
extrapolate pressure on all boundaries?

The default is [no].
extrapolate velocity on out-flow boundaries?

The default is [no].
convergence-acceleration-for-stretched-meshes/
Enables convergence acceleration for stretched meshes to improve the convergence of the implicit
density based solver on meshes with high cell stretching.
correction-tolerance/
Enters the correction tolerance menu.
courant-number
Sets the fine-grid Courant number (time step factor). This command is available only for the coupled
solvers.
data-sampling
Enables data sampling for steady or unsteady flow statistics.
disable-reconstruction?
Completely disables reconstruction, resulting in totally first-order accuracy.
discretization-scheme/
Enters the discretization scheme menu. This allows you to select the discretization scheme for the
convection terms in the solution equations. The following text commands can make a selection from
a subset of the models in the following table:
Index Model
0 First Order Upwind
1 Second Order Upwind
3 Central Differencing
4 QUICK
5 Modified HRIC
6 Third-Order MUSCL
7 Bounded Central
Differencing
8 CICSAM
10 Standard
11 Linear
12 Second Order
13 Body Force Weighted
14 PRESTO!
16 Geo-Reconstruct
28 Compressive
29 BGM
amg-c
Selects the discretization scheme for the flow equations.
epsilon
Selects the discretization scheme for the turbulent dissipation rate.
solve/
k
Selects the discretization scheme for the turbulent kinetic energy.
mom
Selects the discretization scheme for momentum.
mp
Selects which convective discretization scheme for volume fraction is to be used.
pressure
Selects the discretization scheme for pressure.
temperature
Selects the discretization scheme for energy.
divergence-prevention/
Enters the divergence prevention menu. This menu is only available for the density-based solver.
enable?
Enables a divergence prevention option so that Fluent applies under-relaxation to the variables
in select cells where the temperature and/or pressure values are approaching the minimum and/or
maximum limits.
enable-output-dp-dt?
Controls whether the output field variable dp-dt will be available for transient simulation postprocessing.
If you select no, pressure fields at the previous time steps will not be stored in memory which reduces
memory usage.
equation-ordering
Sets the order in which the model equations are solved, which can affect the convergence speed when
you are using the pressure-based solver. The standard method is enabled by default and corresponds
to the ordering shown in Figure 28.7: Overview of the Iterative Time Advancement Solution Method
For the Segregate Solver and Figure 28.8: Overview of the Non-Iterative Time Advancement Solution
Method in the Theory Guide; alternatively, you can select the optimized-for-volumetric-ex-
pansion method, which is recommended for flows in which the density is strongly dependent on
thermal effects, chemical composition, and so on (such as combustion simulations). This text command
is not available for steady simulations and/or when a multiphase model is enabled.
equations/
Selects the equations to be solved.
expert
Sets expert options.
fast-transient-settings/
Enters the fast transient settings menu. This menu is only available for transient cases that use the
density-based solver.
rk2
Allows you to enable the use of a two-stage Runge-Kutta scheme for time integration, or revert to
the default multi-stage Runge-Kutta scheme. This text command is only available for transient
cases that use the density-based explicit formulation.
flow-warnings?
Specifies whether or not to print warning messages when reversed flow occurs at inlets and outlets,
and when mass-flow inlets develop supersonic regions. By default, flow warnings are printed.
flux-type
Sets the flux type.
gradient-scheme
Sets gradient options.
heterogeneous-stiff-chemistry
Sets the heterogeneous stiff-chemistry solver.
high-order-term-relaxation/
Enters the High Order Term Relaxation menu.
enable?
Enables/disables High Order Term Relaxation.
options/
High Order Term Relaxation Options.
relaxation-factor
Sets the relaxation factor.
variables/
Selects the variables.
limiter-warnings?
Specifies whether or not to print warning messages when quantities are being limited. By default,
limiter warnings are printed.
limits
Sets solver limits for various solution variables, in order to improve the stability of the solution.
lock-solid-temperature?
Specifies whether you want to lock (or “freeze”) the temperature values for all the cells in solid zones
(including those to which you have a hooked an energy source through a UDF) and in walls that have
shell conduction enabled, so that the values do not change during further solver iterations.
max-corrections/
Enters the max-corrections menu.
mp-mfluid-aniso-drag
Sets anisotropic drag parameters for the Eulerian multiphase model.
mp-reference-density
Sets the reference density option for the Eulerian multiphase model. The following options are available:
Index VOF Equation Discretization Option

0 mass conservative reference density for a particular phase in a cell is
treated as the volume averaged density of that phase
in the whole domain
solve/
Index VOF Equation Discretization Option

1 mass conservative reference density for a particular phase in a cell is
treated as the density of that phase in that cell
2 mass conservative reference density for any phase in a cell is treated as
the mixture density of that phase in that cell
3 volume conservative reference density for a particular phase in a cell is
treated as the density of that phase in that cell
multi-grid-amg
Sets the parameters that govern the algebraic multigrid procedure.
multi-grid-controls/
Sets multigrid parameters and termination criteria.
multi-grid-fas
Sets the parameters that control the FAS multigrid solver. This command appears only when the explicit
coupled solver is used.
multi-stage
Sets the multi-stage coefficients and the dissipation and viscous evaluation stages. This command
appears only when the explicit coupled solver is used.
multiphase-numerics/
Sets multiphase numerics options.
advanced-stability-controls/
Enters the menu for the stability controls for multiphase flows. For more information about the
below option, see NITA Expert Options and Default and Stability Controls in the Fluent User's Guide.
equation-order/
Enters the equation order menu for homogeneous multiphase flow models.
solve-flow-last?
When enabled, solves the flow equation at the end of the iteration. This improves the be-
haviour at the start of new time-step if the solution does not converge properly.
hybrid-nita/
Enters the equation order menu for homogeneous multiphase flow models.
initial-outer-iterations
Allows you to change the number of initial time-steps and the number of initial outer iter-
ations to control solution stability.
instability-detector/
Enters the menu for the instability detector controls.
enable-instability-detector?
Enables/disables the instability detector to deal with possible instability problems.
set-cfl-limit
Sets the Courant number limit for detecting unstable events. This command is available
enable-instability-detector?
unstable-event-outer-iterations
Sets the number of outer iterations for an unstable event.
outer-iterations
Sets the number of outer iterations.
p-v-coupling/
Enters the menu for the pressure-velocity coupling controls.
coupled-vof/
Enters the stability control menu for VOF cases that involve the Coupled pressure-velocity
coupling scheme.
buoyancy-force-linearization?
Allows you to use the linearized buoyancy force and the blended treatment for the
buoyancy force.
rhie-chow-flux/
Enters the stability controls menu for the Rhie-Chow interpolation.
low-order-rhie-chow?
Enables/disables the low-order velocity interpolation in the flux calculation.
skewness-correction/
Enters the skewness correction menu.
limit-pressure-correction-gradient?
Enables/disables the limited pressure correction gradient in skewness terms for the
PISO, SIMPLEC, or fractional step pressure-coupling schemes.
pseudo-transient/
Enters the stability control menu for cases with the steady-state pseudo-transient method.
false-time-step-linearization?
When enabled, provides additional stability for buoyancy-driven flows in the steady-state
pseudo-transient mode by increasing the diagonal dominance using the false time-step
size.
smoothed-density-stabilization-method?
Smooths the cell density near the interface, therefore avoiding unphysical acceleration of
the lighter phase in the vicinity of interface. The default number of density smoothings is
2. In case of very large unphysical velocities across the interface, you can increase this
number when prompted with Number of density smoothings.
velocity-limiting/
Enters the stability control menu for the velocity limiting treatment.
enable-velocity-limiting?
Enables/disables the velocity limiting treatment.
set-velocity-cutoff
Specifies the maximum velocity magnitude.
boiling-parameters/
Enters the menu for the multiphase boiling model parameters.
solve/
liquid-vof-factor
When enabled, considers liquid volume fraction effects by multiplying the heat transfer coeffi-
cients by the local liquid volume fraction.
thin-film
When enabled, includes multiphase boiling thin film effects using Equation 18.474 in the Fluent
Theory Guide.
compressible-flow/
Enters the compressible multiphase flow numerics menu.
alternate-bc-formulation
Enables an alternative formulation for compressible phases at an inlet boundary. This formulation
calculates static temperature and pressure using an iterative method based on fundamental
thermodynamic relations.
enhanced-numerics
Enables an enhanced numerical treatment that provides better stability at startup and during
calculation of compressible flows.
default-controls/
Enters the default controls menu. This menu is available only for multiphase flows.
recommended-defaults-for-existing-cases
Applies the multiphase defaults (version 2020 R1) to the loaded case file.
Allows you to undo multiphase specific default changes (version 2020 R1) applied to the loaded
case file.
heat-mass-transfer/
Enters the menu for the multiphase heat mass transfer parameters.
alternative-energy-treatment?
Enables the alternative treatment of the energy sources. For more information, see Including
Mass Transfer Effects in the Fluent User's Guide.
area-density/
Enters the menu for the area density.
ia-grad-sym?
Enables/disables the interfacial area density Gradient-Symmetric model. For more inform-
ation about this model, see Algebraic Models in the Fluent Theory Guide.
vof-min-seeding
Sets the minimum volume fraction for the area density and cavitation. This may be useful,
for example, in cases when a species mass transfer model (such as the Symmetric model
or Particle model) do not consider evaporation or condensation if the volume fraction of
one of the phases is zero. The seeding allows for a phase change to occur in the fluid flow.
The default value is 1e-6.
boiling/
Enters the menu for the advanced boiling options for the semi-mechanistic boiling model.
heat-flux-relaxation-factor
Sets the under-relaxation factor for boiling heat flux. See Solution Strategies for the Semi-
Mechanistic Boiling Model in the Fluent User's Guide for details.
show-expert-options?
Exposes the expert options for the semi-mechanistic boiling model. For more information
about these options, see Expert Options for the Semi-Mechanistic Boiling Model in the
Fluent User's Guide.
cavitation/
Enters the cavitation heat mass transfer menu.
min-vapor-pressure
Sets the minimum vapor pressure limit for the cavitation mass-transfer model. The default
value is 1 Pa.
max-vapor-pressure-ratio
Sets the maximum limit on the vapor pressure after the turbulence and thermal correction.
The default value is five times the vapor pressure, with consideration of turbulent and
thermal effects for each cell and phase.
schnerr-cond-coeff
Sets the condensation coefficient for the Schnerr-Sauer model ( in Equation 18.543
in the Fluent Theory Guide). The default and recommended value of 0.2.
schnerr-evap-coeff
Sets the evaporation coefficient for the Schnerr-Sauer model ( in Equation 18.543 in
the Fluent Theory Guide). The default and recommended value of 1.
turbulent-diffusion
enables/disables the turbulent diffusion treatment for a cavitating turbulent flow. See Mass
Transfer Mechanisms in the Fluent User's Guide for details.
nita-controls/
Enters the NITA controls menu.
face-pressure-options
Sets face pressure options for the pressure calculation. When prompted with enable body-
force-weighted for face pressure calculation?, enter yes to select Body
Force Weighted and no to select Second Order as a face pressure interpolation method. See
Controlling NITA Solution Options via the Text Interface in the Fluent User's Guide for details.
porous-media/
Enters the porous media numerics menu.
relative-permeability
Allows you to fix the saturation (volume fraction) of the phase at its user-specified residual
saturation value.
stable-vof-settings?
Executes stable VOF settings. The two available options (defaults + solver changes and
defaults + solver and vof-discretization changes) optimize the solver settings
automatically to provide better stability.
solve/
viscous-flow
Enters the viscous multiphase flow numerics menu.
viscosity-averaging
Forces harmonic averaging of cell viscosities to calculate face viscosity used in momentum
equation. This can improve convergence for highly viscous flow applications (the VOF model
only).
nb-gradient-boundary-option?
Switches between the modified treatment of node-based gradients at boundary cells and the legacy
treatment (R14.5.7 and earlier).
nita-expert-controls/
Enters the NITA expert control menu.
hybrid-nita-settings
Enables and sets hybrid NITA options. For more details, see User Inputs in the Fluent User's Guide.
set-verbosity
Setting this to 1, enables the verbosity for NITA diagnostics. The default value of 0 disables verbosity
output for NITA diagnostics.
skewness-neighbor-coupling
Enables/disables coupling of the neighbor and skewness corrections.
number-of-iterations
Sets the number of iterations for a steady-state simulation without starting the calculation.
numerical-beach-controls
Sets damping function in flow direction. This command appears only when the VOF model is enabled.
Select the damping function to be used:
Index Damping Function

0 Linear
1 Quadratic
2 Cubic
3 Cosine
numerics
Sets numerics options.
open-channel-controls
For flows that do not transition from sub-critical to super-critical, or vice-versa, you can speed-up the
solution calculation by updating the frequency of Froude number during run time.
open-channel-wave-options/
Sets buffer layer height, verbosity, and open channel wave theory formulation.
set-buffer-layer-ht
Sets the buffer layer height.
set-verbosity
Sets the open channel wave verbosity.
stokes-wave-variants
Specifies which open channel wave theory formulation Fluent uses.
overset/
Specifies overset meshing solver options.
high-order-pressure?
Uses the pressure gradient of the donor cell in the interpolation of pressure for its receptor cell.
interpolation-method
Selects the interpolation method for overset interfaces. Note that the least squares method is re-
commended for sliding mesh cases.
orphan-cell-treatment?
Enables/disables a numerical treatment that attempts to assign reasonable data values to orphan
cells.
p-v-controls
Sets pressure-velocity controls.
p-v-coupling
Selects which pressure-velocity coupling model is to be used. Four models are available:
Index Model
20 SIMPLE
21 SIMPLEC
22 PISO
24 Coupled
phase-based-vof-discretization
Sets phase based slope limiter for VOF compressive scheme.
poor-mesh-numerics/
Enters the poor mesh numerics menu.
cell-quality-based?
Enables/disables poor mesh numerics on cells with low quality.
enable?
Solution correction on meshes of low quality.
print-poor-elements-count
Prints out a listing of the poor cells for each criterion (default, cell quality, and user-defined).
reset-poor-elements?
Resets the list of poor cells included based on quality criteria or user-defined registers.
set-quality-threshold
Sets the threshold for quality-based inclusion in the poor mesh numerics. The threshold value is
applied to cell orthogonality and the complement of cell skewness.
user-defined-on-register
Includes a register for the poor mesh numerics or not.
solve/
previous-defaults/
Provides text commands that allow you to undo enhancements to the default solver behavior.
Allows you to undo enhancements introduced in version 2019 R1 of ANSYS Fluent, including:
• Maintaining positivity for turbulence variables. These enhancements affect the solution when
using an overset interface with the default least squares interpolation method, and may affect
convergence when using an -based turbulence model or a second-order advection scheme
for the turbulence equations. On occasion, these enhancements may have a small adverse effect
on performance.
• Using the coupled pseudo-transient solver as a default solver for steady-state, single-phase
problems (except for cases that use the battery, fuel cells, melting, or solidification models). If
you choose to undo these enhancements, the pressure-velocity coupling scheme will revert to
its previous setting.
• Using a more aggressive pseudo time step size for the automatic pseudo time scale method.
This enhancement affects the solution when using the coupled pseudo-transient solver and may
improve convergence in some cases.
Allows you to undo enhancements introduced in version 2019 R3 of ANSYS Fluent, including:
• Using a formulation for the Rhie-Chow face flux interpolation in the pressure-based solver
for single-phase simulations that includes a velocity reconstruction designed to handle
non-uniform meshes. For such meshes, this formulation gives more accurate results and
prevents non-physical reflections of error waves. Note that for poor quality meshes, while
the default under-relaxation factors should work, this formulation may require you to use
a smaller under-relaxation factor, a smaller flow Courant number, a smaller pseudo time
step size, and/or high order term relaxation (HOTR).
• Using a discretization for poor mesh numerics that enhances robustness for meshes with
wall boundary layer resolution (for example, y+=1). This discretization is especially effective
at wall surfaces that have high curvature and/or high aspect ratios of the near-wall cells.
It is primarily intended to prevent divergence, though it may also improve the solution
accuracy.
Allows you to undo enhancements introduced in version 19.0 of ANSYS Fluent, including the
treatment of symmetry boundary conditions and the treatment of walls with the specified shear
condition, as well as an early protection scheme for the linear solver.
pseudo-relaxation-factor/
Enters the pseudo relaxation factor menu.
pseudo-transient
Sets the pseudo transient formulation.
pseudo-transient-expert/
Enters the pseudo transient expert usage control menu.
reactions?
Enables the species reaction sources and sets relaxation factor.
relaxation-factor/
Enters the relaxation-factor menu.
relaxation-method
Sets the solver relaxation method.
reporting-interval
Sets the number of iterations for which convergence monitors are reported. The default is 1 (after
every iteration).
residual-smoothing
Sets the implicit residual smoothing parameters. This command is available only for the explicit coupled
solver.
residual-tolerance/
Enters the residual tolerance menu.
residual-verbosity
Sets the amount of residual information to be printed. A value of 0 (the default) prints residuals at the
end of each fine grid iteration. A value of 1 prints residuals after every stage of the fine grid iteration.
A value of 2 prints residuals after every stage on every grid level.
second-order-time-options
Enables / disables the variable time step size formulation for second-order implicit transient formulations.
If you disable the variable time step size formulation, note that any change in the time step size will
introduce an error proportional to the change in the time step size ratio.
set-all-species-together
Sets all species discretizations and URFs together.
set-controls-to-default
Sets controls to default values.
set-solution-methods-to-default
Sets the solution methods to the default settings.
set-solution-steering
Sets solution steering parameters.
slope-limiter-set/
Selects a new Fluent solver slope limiter.
solution-steering
Enables solution steering for the density-based solver.
stiff-chemistry
Sets solver options for stiff chemistry solutions.
surface-tension
Sets surface-tension calculation options.
transient-controls/
Enters the transient controls menu, which allows you to define settings related to time advancement
for transient flow calculations.
solve/
cfl-based-time-stepping
Allows you to specify that an adaptive time stepping method is used in which the time step gets
modified by ANSYS Fluent as the calculation proceeds such that the Courant–Friedrichs–Lewy
(CFL) condition is satisfied, using the specified Courant number.
duration-specification-method
Sets the method by which you will specify the duration of the calculation. The duration can be
defined by the total time, the total number of time steps, the incremental time, or the number of
incremental time steps. In this context, "total" indicates that Fluent will consider the amount of
time / steps that have already been solved and stop appropriately, whereas "incremental" indicates
that the solution will proceed for a specified amount of time / steps regardless of what has previously
been calculated. This text command is only available when the time stepping is adaptive or based
on a user-defined function.
error-based-time-stepping
modified by ANSYS Fluent based on the specified truncation error tolerance.
extrapolate-eqn-vars/
Enters the extrapolation menu.
extrapolate-vars?
Applies a predictor algorithm for computing initial conditions at time step n+1. The predictor al-
gorithm is a computation that sets a better initial condition for the time step.
fixed-periodic
Allows you to specify that a fixed time stepping method is used in which a specified period or
frequency is the basis for determining the time step size and number of time steps.
fixed-user-specified
Allows you to specify that a fixed time stepping method is used in which you directly specify the
time step size and number of time steps.
incremental-time
Sets the amount of incremental (that is, additional) time to run the simulation, regardless of how
much time has already been run in previous calculations. This text command is only available when
the solve/set/transient-controls/duration-specification-method is set to 3.
max-flow-time
Sets the maximum flow time.
max-iterations-per-time-step
Sets the number of time steps for a transient simulation.
Note:
This option is available when automatic initialization and case modification is

enabled.
multiphase-specific-time-stepping
modified by ANSYS Fluent based on the convective time scale (global Courant number): the time-
step-size calculation depends on the mesh density and velocity in interfacial cells. This method is
available for all multiphase models using the implicit or explicit volume fraction formulation, except
for the wet steam model.
number-of-time-steps
Sets the number of time steps for a transient simulation without starting the calculation.
predict-next-time?
Applies a predictor algorithm for computing the next time step. The predictor algorithm is a
computation that sets a better initial condition for the time step. It uses the rate of change between
the prediction and the correction as an indicator for whether the next time step should be larger,
smaller, or the same as the current one.
rotating-mesh-flow-predictor?
Enables / disables an option that allows for better prediction of the flow field in rotating fluid zones
at every time step, in order to speed up the calculation. This text command is only available for
transient simulations.
solid-time-step-size
Allows you to specify that the time step size used for solid zones is independent from that used
for fluid zones. This text command is only available when both a solid zone exists and energy is
enabled.
solution-status
Allows you to open the Simulation Status dialog box, which reports details about the simulation.
specified-time-step
Specifies whether to define the transient advancement either directly by entering a time step size
/ period / frequency (using the text commands available in the solve/set/transient-con-
trols menu) or indirectly by entering a Courant number value (using the solve/set/courant-
number text command). This text command is only available for the density-based solver when
both the explicit formulation and explicit transient formulation are used.
time-step-size
Sets the magnitude of the (physical) time step . This text command is only available when the
solve/set/transient-controls/fixed-user-specified text command is set to yes.
time-step-size-for-acoustic-export
Specifies the time interval for acoustic data sampling. This text command is only available when
both the Ffowcs Williams and Hawkings model is selected and the density-based solver is used
with the explicit formulation and explicit transient formulation.
total-number-of-time-steps
Sets the total number of time steps that the simulation will run (which includes any time steps that
have already been run in previous calculations). This text command is only available when the
solve/set/transient-controls/duration-specification-method is set to 1.
total-time
Sets the total amount of time that the simulation will be run (which includes any time that has
already been run in previous calculations). This text command is only available when the
solve/set/transient-controls/duration-specification-method is set to 2.
udf-based-time-stepping
Allows you to specify that the time step size is defined by a user-defined function (UDF) that uses
the DEFINE_DELTAT macro.
solve/
undo-timestep
When enabled, if the truncation error within a time step exceeds the specified tolerance Fluent
will automatically undo the current calculation and make another attempt with the time step re-
duced by 1/2. This will be attempted up to 5 times after which Fluent will accept the result and
proceed to the next time step.
under-relaxation/
Enters the under-relaxation menu, which allows you to set the under-relaxation factor for each equation
that is being solved in a segregated manner.
vof-explicit-controls
Sets the sub time step calculation method for VOF calculations.
vof-numerics
Sets VOF numeric options.
warped-face-gradient-correction/
Enters the warped-face gradient correction menu.
enable?
Enables/disables gradient enhancement computations and specifies whether Fluent uses fast or
memory saving mode.
update-physical-time
Advances the unsteady solution to the next physical time level. Using this command in conjunction with
the iterate command allows you to manually advance the solution in time (rather than doing it auto-
matically with the dual-time-iterate command).
Chapter 13: surface/
circle-slice
Extracts a circular slice.
delete-surface
Removes a defined data surface.
edit-surface
Allows you to edit any of the listed available surfaces.
imprint-surface
Enters the list of surfaces to imprint from and the name of the new imprinted surface.
iso-clip
Clips a data surface (surface, curve, or point) between two isovalues.
iso-surface
Extracts an iso-surface (surface, curve, or point) from the current data field.
line-slice
Extracts a linear slice in 2D, given the normal to the line and a distance from the origin.
line-surface
Defines a “line" surface by specifying the two endpoint coordinates.
list-surfaces
Displays the ID and name, and the number of point, curve, and surface facets of the current surfaces.
mouse-line
Extracts a line surface that you define by using the mouse to select the endpoints.
mouse-plane
Extracts a planar surface defined by selecting three points with the mouse.
mouse-rake
Extracts a “rake" surface that you define by using the mouse to select the endpoints.
multiple-zone-surfaces
Creates multiple data surfaces at one time. Accepts zone names, lists of zone ID’s, and wildcards.
partition-surface
Defines a data surface consisting of mesh faces on the partition boundary.
plane-slice
Extracts a planar slice.
plane-surface
Create a plane from a coordinate plane, point and normal, or three points.
surface/
point-array
Extracts a rectangular array of data points.
point-surface
Defines a “point" surface by specifying the coordinates.
quadric-slice
Extracts a quadric slice.
rake-surface
Extracts a “rake" surface, given the coordinates of the endpoints.
rename-surface
Renames a defined data surface.
reset-zone-surfaces
Recreates missing surface zones by resetting the case surface list.
sphere-slice
Extracts a spherical slice.
structural-point-surface
Defines a structural “point" surface by specifying the coordinates.
surface-cells
Extracts all cells intersected by a data surface.
transform-surface
Transforms surface.
zone-surface
Creates a surface of a designated zone and gives it a specified name.
Chapter 14: switch-to-meshing-mode
switch-to-meshing-mode
Switches from the solution mode to the meshing mode. This text command is only available if you have
not yet read a mesh or a case file.
Chapter 15: turbo-post/
2d-contours
Displays 2D contours.
avg-contours
Displays average contours.
compute-report
Computes turbomachinery quantities.
current-topology
Sets the current turbo topology for global use.
write-report
Writes the turbo report to file.
xy-plot-avg
Displays average XY plots.
Chapter 16: views/
auto-scale
Scales and centers the current scene without changing its orientation.
camera/
Enters the camera menu to modify the current viewing parameters.
dolly-camera
Adjusts the camera position and target.
field
Sets the field of view (width and height).
orbit-camera
Adjusts the camera position without modifying the target.
pan-camera
Adjusts the camera target without modifying the position.
position
Sets the camera position.
projection
Toggles between perspective and orthographic views.
roll-camera
Adjusts the camera up-vector.
target
Sets the point to be the center of the camera view.
up-vector
Sets the camera up-vector.
zoom-camera
Adjusts the camera’s field of view. This operation is similar to dollying the camera in or out of the scene.
Dollying causes objects in front to move past you. Zooming changes the perspective effect in the scene
(and can be disconcerting).
default-view
Resets view to front and center.
delete-view
Removes a view from the list.
last-view
Returns to the camera position before the last manipulation.
views/
list-views
Lists predefined and saved views.
read-views
Reads views from a view file.
restore-view
Uses a saved view.
save-view
Saves the current view to the view list.
write-views
Writes selected views to a view file.
Chapter 17: battery-model/
This chapter has the following sections:
17.1. Single-Potential Empirical Battery Model
17.2. Dual-Potential MSMD and Circuit Network Battery Models
17.1. Single-Potential Empirical Battery Model

Once the battery module is loaded, you can access the text user interface through the Console Window
under battery-model. A listing of the various text commands is as follows:
battery-model/
Enters the battery model menu
activation-parameters/
Activation parameter setup.
t-coefficients
Specifies the temperature coefficients in Equation 24.6 and Equation 24.7.
u-coefficients
Specifies the U coefficients for Equation 24.3.
y-coefficients
Specifies the Y coefficients for Equation 24.4.
anode-interface
Anode interface options.
cathode-interface
Cathode interface options.
electric-field-model/
Sets electric field.
conductive-regions
Lists zone names and IDs.
contact-resistance-regions
current-tap
voltage-tap
battery-model/
electrochemistry
Sets electrochemistry parameters.
enable-battery-model?
Enables/disables battery model.
model-parameters
Sets model parameters.
17.2. Dual-Potential MSMD and Circuit Network Battery Models

Once the battery module is loaded, you can access the text user interface through the Console Window
by entering define models battery-model. A listing of the various text commands is as follows:
battery-model/
Enters the battery model menu.
enable-battery-model?
Enables/disables battery model.
Enters the electric field setup menu.
conductive-regions
Specifies active conductive regions.
Specifies contact resistance regions.
current-tap
Sets cathode tap.
voltage-tap
Sets anode tap.
model-parameters
Sets battery model options (see Specifying Battery Model Options for definitions of the model general
parameters).
solution-method
Sets solution method options (see Specifying Battery Model Options in the Fluent User's Guide for details).
ntgk-parameters
Sets NTGK model-specific parameters (see Inputs for the NTGK Empirical Model for definitions of the
NTGK model parameters).
ecm-parameters
Sets ECM model-specific parameters (see Inputs for the Equivalent Circuit Model for definitions of the
ECM model parameters).
newman-parameters
Sets Newman model-specific parameters (see Inputs for the Equivalent Circuit Model for definitions
of the Newman model parameters).
Dual-Potential MSMD and Circuit Network Battery Models
parameter-estimation-tool
Computes the model parameters from battery's testing data. You can use the estimation tool to compute
model parameters for the NTGK or ECM model, or for the One-Equation thermal abuse model. You
must provide battery's testing data as a text file in a specific format for each model. When you enable
this tool and select the model option, Fluent will show the required format for the input file in the
console. For more details, see Using Parameter Estimation Tools. You can contact ANSYS Technical
Support for clarifications on how to use this tool.
thermal-abuse-model
Allows you to choose a thermal abuse model and specify its parameters (see Specifying Advanced
Option in the Fluent User's Guide for more details).
Chapter 18: Fuel Cell Text Commands
This chapter is divided into the following sections:
18.1. Using the PEMFC Text User Interface
18.2. Using the Fuel Cell and Electrolysis Text User Interface
18.3. Using the Solid Oxide Fuel Cell With Unresolved Electrolyte Text User Interface
18.1. Using the PEMFC Text User Interface

All of the features for the PEMFC model that are available through the graphical user interface are also
available through text user interface (TUI) commands. The TUI allows text commands to be typed directly
in the ANSYS Fluent console window where additional information can be extracted and processed for
more advanced analysis.
Once the fuel cell module is loaded (see Loading the PEMFC Module), you can access the text user in-
terface through the console window under define/models/pemfc/. A listing of the various text
commands is as follows:
advanced-setup/
Advanced setup.
list-zones-briefly
List zone names and IDs.
contact-resistivity
Set contact resistivity.
coolant-channel
Set coolant channel.
stack-management/
Stack setup.
list-fc-units
List fuel cell units.
list-zones-briefly
create-fc-unit
Create fuel cell unit.
modify-fc-unit
Modify fuel cell unit.
delete-fc-unit
Delete fuel cell unit.
Fuel Cell Text Commands
set-stack-current-density
Set the current density on the anode or cathode and modify the current solution to assist conver-
gence. Note: Input here is in units of A/cm2. This is only available if the case contains valid data
(for example, after initialization, iterating, or reading in data). For more information, see IV-Curve
Calculations Using the Text Interface (p. 395).
set-stack-voltage
Set the voltage difference in Volts between the anode and the cathode and modify the current
solution to assist convergence. This is only available if the case contains valid data (for example,
after initialization, iterating, or reading in data). For more information, see IV-Curve Calculations
Using the Text Interface (p. 395).
reset-setup
Reset the stack setup in case mistakes are made.
submit-setup
Submit the stack setup and makes the stack setup take effect.
anode-setup/
Anode setup.
catalyst-layer
Set catalyst layer.
current-collector
Set current collector.
electrolyte-layer
Set electrolyte layer.
flow-channel
Set flow channel.
list-zones-briefly
micro-porous-layer
Set micro-porous layer.
porous-electrode
Set porous electrode.
cathode-setup/
Cathode setup.
catalyst-layer
Set catalyst layer.
current-collector
electrolyte-layer
Using the PEMFC Text User Interface
flow-channel
Set flow channel.
list-zones-briefly
micro-porous-layer
porous-electrode
electrolyte-setup/
Electrolyte setup.
catalyst-layer
Set catalyst layer.
current-collector
electrolyte-layer
flow-channel
Set flow channel.
list-zones-briefly
micro-porous-layer
porous-electrode
enable-fc-model?
Enable/disable PEMFC model.
model-options
Model options.
model-parameters
Model parameters.
reports
Set electrolyte project area and external contacts.
18.1.1. IV-Curve Calculations Using the Text Interface

For valid case and data files, there are two text commands available to assist in the IV-curve calculation.
These commands are set-stack-voltage (aliased as ssv) and set-stack-current-density
(aliased as ssc), available from the PEMFC text command menu: /define/models/pemfc/ad-
vanced-setup/stack-management/.
For fuel cells, you either prescribe the voltage and obtain the total current delivered by the fuel cell
as a result, or you specify the total current (via flux boundary conditions multiplied by the area) and
obtain the voltage as part of the solution. The details of this IV-relation are specific for each single
fuel cell and depend on mass and heat transport, electrochemistry and inlet conditions, outlet condi-
tions, operating conditions, and any other parameter or material property involved in the calculation.
The IV-curve is important for applications, because its product is the power delivered by the system.
As described earlier in this manual, you would start a new simulation from fairly static conditions,
that is, high voltage/low current (which implies low species transport and low heat generation). After
convergence, you typically may be interested in solutions for new electric boundary conditions, that
is, either for a new cell/stack voltage or current.
In such cases, simply going to the Boundary Conditions task page and changing the value of the
electric potential (uds-0) boundary condition, typically allows only small changes, most notably for
stacks. Otherwise the solution will not converge. This is where the set-stack-voltage and set-
stack-current-density commands are important.
In addition to changing the boundary conditions (either to a prescribed voltage or current density),
these commands process the current data in order to estimate the solution for the new boundary
conditions. Because these commands modify the data, you are prompted to save your data, if you
have not already done so.
Before going into details of the commands, here are some general remarks about electric potential
boundary conditions.
For fixed voltage boundary conditions, both external contacts have a fixed value for the electric po-
tential (uds-0). The anode value will typically be zero, but it does not have to be. The cathode value
will be larger than the anode value and the difference ( - ) is the positive cell/stack
voltage.
For a fixed current boundary condition, one external contact has to have a fixed value and the other
flux boundary conditions. As described earlier in the manual, typically, the anode will have a fixed
(zero) value, and the cathode will be floating, however, you can also set the cathode to a fixed zero
potential, yielding a floating negative anode potential.
The set-stack-voltage command sets the effective stack voltage, that is, the difference ( -
). For fixed voltage boundary conditions for the previous solution, boundary conditions on both
boundaries are of type fixed value and then the cathode value will be changed accordingly. In the
case of fixed current boundary conditions for the previous solution, the flux boundary condition will
be changed to a fixed value boundary condition, and the value adjusted accordingly with respect to
the other fixed value boundary condition.
The set-stack-current-density command sets the current density on one boundary to the
desired value. Note that the input will be in , not as you would normally have to enter in the
Boundary Conditions task page. The reason for this is that average current densities reported in the
text command interface are also in , and this makes it easier to choose the conditions you would
like to prescribe next. Also, flux boundary conditions entered in the Boundary Conditions dialog
box would have to have a positive sign on the anode side, and a negative sign on the cathode side.
The input for the text interface command is just a positive number, signs are automatically accounted
for.
For fixed current boundary conditions for the previous solution, the set-stack-current-density
command changes the respective flux boundary condition accordingly. In the case of fixed voltage
Using the Fuel Cell and Electrolysis Text User Interface
boundary conditions for the previous solution, the cathode side is chosen to be changed from a fixed
value to a flux boundary condition with the new flux.
The two commands may be mixed in an IV-curve calculation. For the type of boundary condition
setups currently described in this manual, boundary condition changes will consistently happen on
the cathode side. However, if anode flux boundary conditions had been chosen initially, switching to
fixed voltage boundary conditions by set-stack-voltage command and then back to fixed current
boundary conditions by the set-stack-current-density command will then have flux
boundary conditions on the cathode side. In this case, using the set-stack-current-density
command exclusively will preserve the anode flux boundary condition setting.
18.2. Using the Fuel Cell and Electrolysis Text User Interface
All of the features for the Fuel Cell and Electrolysis Model (sometimes referred to as the Resolved Elec-
trolyte model) that are available through the graphical user interface are also available through text
user interface (TUI) commands. The TUI allows text commands to be typed directly in the ANSYS Fluent
console window where additional information can be extracted and processed for more advanced
analysis.
Once the fuel cell module is loaded (see Loading the Fuel Cell and Electrolysis Module), you can access
the text user interface through the console window under define/models/resolved-MEA-fc/.
A listing of the various text commands is as follows:
resolved-MEA-fuelcells/
Fuel cell model menu.
advanced-setup/
Advanced setup.
contact-resistivity
Set contact resistivity.
coolant-channel
Set coolant channel.
list-zones-briefly
stack-management/
Stack setup.
create-fc-unit
Create fuel cell unit.
delete-fc-unit
Delete fuel cell unit.
list-fc-units
List fuel cell units.
list-zones-briefly
modify-fc-unit
Modify fuel cell unit.
reset-setup
Reset the stack setup in case mistakes are made.
set-stack-current-density
Set the current density on the anode or cathode and modify the current solution to assist
convergence. Note: Input here is in units of A/cm2. This is only available if the case contains
valid data (for example, after initialization, iterating, or reading in data). For more information,
see IV-Curve Calculations Using the Text Interface (p. 400).
set-stack-voltage
Set the voltage difference in Volts between the anode and the cathode and modify the current
solution to assist convergence. This is only available if the case contains valid data (for example,
after initialization, iterating, or reading in data). For more information, see IV-Curve Calculations
Using the Text Interface (p. 400).
submit-setup
Submit the stack setup and makes the stack setup take effect.
suggest-setup
Suggest the stack setup, invoking the automatic stack setup.
anode-setup/
Anode setup.
catalyst-layer
Set catalyst layer.
current-collector
electrolyte-layer
flow-channel
Set flow channel.
list-zones-briefly
porous-electrode
cathode-setup/
Cathode setup.
catalyst-layer
Set catalyst layer.
current-collector
Using the Fuel Cell and Electrolysis Text User Interface
electrolyte-layer
flow-channel
Set flow channel.
list-zones-briefly
porous-electrode
electrolyte-setup/
Electrolyte setup.
catalyst-layer
Set catalyst layer.
current-collector
electrolyte-layer
flow-channel
Set flow channel.
list-zones-briefly
porous-electrode
enable-fc-model?
Enable/disable fuel cell model.
model-options
Model options.
model-parameters
Model parameters.
reports
Set electrolyte project area and external contacts.
select-model
Select model.
set-default
Set default.
18.2.1. IV-Curve Calculations Using the Text Interface

For valid case and data files, there are two text commands available to assist in the IV-curve calculation.
These commands are set-stack-voltage (aliased as ssv) and set-stack-current-density
(aliased as ssc), available from the Fuel Cell and Electrolysis text command menu: /define/mod-
els/resolved-MEA-fc/advanced-setup/stack-management/.
For fuel cells, you either prescribe the voltage and obtain the total current delivered by the fuel cell
as a result, or you specify the total current (via flux boundary conditions multiplied by the area) and
obtain the voltage as part of the solution. The details of this IV-relation are specific for each single
fuel cell and depend on mass and heat transport, electrochemistry and inlet conditions, outlet condi-
tions, operating conditions, and any other parameter or material property involved in the calculation.
The IV-curve is important for applications, because its product is the power delivered by the system.
As described earlier in this manual, you would start a new simulation from fairly static conditions,
that is, high voltage/low current (which implies low species transport and low heat generation). After
convergence, you typically may be interested in solutions for new electric boundary conditions, that
is, either for a new cell/stack voltage or current.
In such cases, simply going to the Boundary Conditions task page and changing the value of the
electric potential (uds-0) boundary condition, typically allows only small changes, most notably for
stacks. Otherwise the solution will not converge. This is where the set-stack-voltage and set-
stack-current-density commands are important.
In addition to changing the boundary conditions (either to a prescribed voltage or current density),
these commands process the current data in order to estimate the solution for the new boundary
conditions. Because these commands modify the data, you are prompted to save your data, if you
have not already done so.
Before going into details of the commands, here are some general remarks about electric potential
boundary conditions.
For fixed voltage boundary conditions, both external contacts have a fixed value for the electric po-
tential (uds-0). The anode value will typically be zero, but it does not have to be. The cathode value
will be larger than the anode value and the difference ( - ) is the positive cell/stack
voltage.
For a fixed current boundary condition, one external contact has to have a fixed value and the other
flux boundary conditions. As described earlier in the manual, typically, the anode will have a fixed
(zero) value, and the cathode will be floating, however, you can also set the cathode to a fixed zero
potential, yielding a floating negative anode potential.
The set-stack-voltage command sets the effective stack voltage, that is, the difference ( -
). For fixed voltage boundary conditions for the previous solution, boundary conditions on both
boundaries are of type fixed value and then the cathode value will be changed accordingly. In the
case of fixed current boundary conditions for the previous solution, the flux boundary condition will
be changed to a fixed value boundary condition, and the value adjusted accordingly with respect to
the other fixed value boundary condition.
The set-stack-current-density command sets the current density on one boundary to the
desired value. Note that the input will be in , not as you would normally have to enter in the
Boundary Conditions task page. The reason for this is that average current densities reported in the
Using the Solid Oxide Fuel Cell With Unresolved Electrolyte Text User Interface
text command interface are also in , and this makes it easier to choose the conditions you would
like to prescribe next. Also, flux boundary conditions entered in the Boundary Conditions dialog
box would have to have a positive sign on the anode side, and a negative sign on the cathode side.
The input for the text interface command is just a positive number, signs are automatically accounted
for.
For fixed current boundary conditions for the previous solution, the set-stack-current-density
command changes the respective flux boundary condition accordingly. In the case of fixed voltage
boundary conditions for the previous solution, the cathode side is chosen to be changed from a fixed
value to a flux boundary condition with the new flux.
The two commands may be mixed in an IV-curve calculation. For the type of boundary condition
setups currently described in this manual, boundary condition changes will consistently happen on
the cathode side. However, if anode flux boundary conditions had been chosen initially, switching to
fixed voltage boundary conditions by set-stack-voltage command and then back to fixed current
boundary conditions by the set-stack-current-density command will then have flux
boundary conditions on the cathode side. In this case, using the set-stack-current-density
command exclusively will preserve the anode flux boundary condition setting.
18.3. Using the Solid Oxide Fuel Cell With Unresolved Electrolyte Text
User Interface
All of the features for the Solid Oxide Fuel Cell With Unresolved Electrolyte Model that are available
through the graphical user interface are also available through text user interface commands.
Once the fuel cell module is loaded (see Loading the Solid Oxide Fuel Cell With Unresolved Electrolyte
Module), you can access the text user interface through the Console Window under sofc-model. A
listing of the various text commands is as follows:
sofc-model/
SOFC model menu
enable-sofc-model?
Enable/disable SOFC model
model-parameters
Set model parameters
electrochemistry
Set electrochemistry parameters
anode-interface
Set fuel cell anode interface
cathode-interface
Set fuel cell cathode interface
tortuosity-interface
Set fuel cell tortuosity interface
Electric field model
voltage-tap
Set voltage tap surface
current-tap
Set current tap surface
conductive-regions
Set conductive regions
Set contact resistance regions
Chapter 19: Magnetohydrodynamics Text Commands
These are the MHD module text commands available under define/models/:
b0-scale-factor
Set and apply external magnetic field scale factor.
Define MHD boundary conditions
list-zones
List ANSYS Fluent zone information.
fluid
Set fluid zone boundary condition.
solid
Set solid zone boundary condition.
wall
Set wall boundary condition.
enable-mhd?
Enable/disable MHD model.
external-b0-field
Set and apply external magnetic field data.
initialize-dpm
Initialize DPM related MHD variables.
initialize-mhd
Initialize MHD model.
mhd-method
Select MHD method.
reset-b0-field
Reset external magnetic field data.
solution-control
Set MHD solution control parameters.
Chapter 20: continuous-fiber/
All of the features for the continuous fiber module that are available through the graphical user interface
are also available through text user interface (TUI) commands. The TUI allows text commands to be
typed directly in the ANSYS Fluent console window where additional information can be extracted and
processed for more advanced analysis.
Once the fiber module is loaded, you can access the text user interface through the Console Window
by pressing return in the console (assuming that you are at the top level menu, that is, not in any other
menu such as define/). A listing of the various text commands is as follows:
continuous-fiber/
Enter the continuous-fiber menu.
define/
Define fiber models and injections.
injection
Define and modify fiber injections.
model
Select a fiber model.
file/
Read and write fiber data.
read-fiber-data
Read in fiber data file.
write-binary-fiber-data
Write a fiber data file in binary format.
write-fiber-data
Write a fiber data file in standard format.
print
Print the fiber data of all defined injections into history files.
print-xy
Select two fiber variables for plotting into an xy file.
solve/
Solver settings for computing fibers.
compute
Compute the fibers for all of the injections.
initialize
Initialize all of the fibers and injections.
continuous-fiber/
set/
Set solution parameters for the fiber model.
discretization-scheme/
Select the discretization scheme for convection terms.
energy
Choose a discretization scheme for the fiber energy equation.
momentum
Choose a discretization scheme for the fiber momentum equation.
species
Choose a discretization scheme for the fiber species equation.
equations/
Select the equations that will be solved.
energy
Specify the energy equation that will be solved.
momentum
Specify the momentum equation that will be solved.
species
Specify the species equation that will be solved.
interaction/
Set parameters for coupled fiber calculations.
coupled-calculations?
Select whether to couple fiber and fluid flow calculations.
no.-of-fluid-iters-per-fiber-iter
Set the number of fluid flow iterations per fiber iteration.
underrelaxation
Set the underrelaxation factor of the fiber source terms in the fluid flow.
monitors/
Set the residual monitors of the fibers.
check?
Choose which currently-selected equations should be checked for convergence.
Set the criteria to stop the fiber calculation.
relative-residuals?
Choose whether relative or absolute convergence criteria will be used.
no-of-iterations
Set the number of fiber iterations that will be computed.
reporting-interval
Set the reporting frequency for the fiber model.
under-relaxation/
Set the underrelaxation parameters.
energy
Specify the underrelaxation factor for the energy equation.
momentum
Specify the underrelaxation factor for the momentum equation.
species
Specify the underrelaxation factor for the species equation.

ANSYS Fluent Text Command List

Uploaded by

Copyright:

Available Formats

ANSYS Fluent Text Command List

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ANSYS Fluent Text Command List

Uploaded by

Copyright:

Available Formats

ANSYS Fluent Text Command List

ANSYS, Inc. Release 2020 R1

© 2020 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.

U.S. Government Rights

Published in the U.S.A.

B. Boundary Functions ........................................................................................................................ 175

• exit (p. 71) lists the command to close the program.

• parallel/ (p. 135) lists commands specific to parallel processing.

• adjoint/ (p. 217) lists commands related to the adjoint solver.

• parallel/ (p. 339) lists commands specific to parallel processing.

• plot/ (p. 343) lists commands specific to plotting data.

2.1. Text Menu System

/display > set

You can move directly to a menu by giving its full pathname.

For additional information, refer to the following sections:

2.1.1. Command Abbreviation

• A command name consists of "phrases" separated by hyphens.

• A command is matched by matching an initial sequence of its phrases.

• Matching of hyphens is optional.

• A phrase is matched by matching an initial sequence of its characters.

• A character is matched by typing that character.

The rules for "matching" a command are:

• Occasionally, there is an anomaly such as lint not matching lighting-interpolation because

This can be resolved by choosing a different abbreviation, such as liin, or l-int.

2.1.2. Command Line History

2.1.3. Scheme Evaluation

2.2. Text Prompt System

shrink-factor [0.1] Enter

line-weight [1] Enter

To abort a prompt sequence, simply press Ctrl+c.

• Integers can also be specified in binary, octal, and hexadecimal form.

• The decimal integer 31 can be entered as 31, #b11111, #o37, or #x1f.

• * will translate as “all zones”.

– /boundary/delete-island-faces wrap* enables you to delete island faces on all zones

• > will translate as “all zones visible in the graphics window”.

• ^ will translate as “all zones selected in the graphics window”.

• [object_name will translate as “all zones with the name object_name”.

• [object_name/label_name will translate as "all zones with label_name of object_name"

For example, /boundary/manage/delete [fluid/box*, yes enables you to delete all

wall-1 wall-3 wall-5

element(3) [()] 100

element(4) [()] Enter

creates a list of three numbers: 1, 10, and 100. Subsequently,

element(2) [10] Enter

element(3) [100] Enter

element(4) [()] 1000

element(5) [()] Enter

adds a fourth element. Then

element(2) [10] Enter

leaves only 1 and 10 in the list. Subsequently entering

An example of a “list-of-scalars” consists of the following:

y-component [0.0] (sqrt (/ 8 9))

y-component [0.0] (unit-y (/ 1 3))

2.2.8. Default Value Binding

2.4. System Commands

For additional information, see the following sections:

2.4.1. System Commands for LINUX-based Operating Systems

> !vi script.rp

Example input (in the ANSYS Fluent console):

> !ls valve.

:cell_delete_1, :cell_delete_2, *:cell_delete_3,.... up to \