The command-line options for cfx5solve
are described below. To
see command-line help, from a CFX command line run:
cfx5solve -help | more
Note: When running the solver from the command line using a CFX-Solver input file or CFX-Solver results file, any execution control CCL contained in the file takes precedence over the command-line options.
If an option is specified multiple times within the context of a specific configuration, then the last specification of the option takes precedence.
Command-Line Options |
Alternative form |
Usage |
---|---|---|
|
|
Applying process affinity restricts execution of a solver process to a processing element (for example, a CPU core) so that the process is not free to migrate between processing elements. This can improve performance by increasing the use of cached data. MPI implementations are usually able to apply process affinity; this is typically enabled by default, although the behavior may vary depending on the hardware and operating system configuration. The CFX-Solver accepts the following values for
Note that Windows HPC systems may report the host topology as being unavailable; this is expected. In this case, the job scheduling system usually sets the process affinity, hence setting the affinity in the solver is unnecessary. In all cases, the solver checks if any other CFX-Solver processes are running on the hosts used. If other running processes are detected, affinity is not applied by the solver in order to avoid overloading a given processing element, which can strongly degrade performance. |
|
|
Causes the flow solver to write a backup file every
|
|
|
Starts CFX-Solver in batch mode (that is, without starting the CFX-Solver Manager interface). |
|
|
Reads Command Language from the named file, and uses it to provide
defaults for the current run. If the file specifies a CFX-Solver input
file for the run, the command language contained in that
CFX-Solver input file will take precedence over that supplied. Also see
the |
|
|
Reads additional Command Language from the named file. Overrides
most CFX Command Language specified in the CFX-Solver input file. If
|
|
|
Starts <executable> instead of the standard Ansys CFX
|
|
|
Starts <executable> instead of the standard Ansys CFX
|
|
Sets the working directory as specified. | |
|
|
When running in batch mode, this will cause
|
|
|
Applies subsequent options to the specified configuration. |
|
|
Uses initial values and continues the run from the specified
CFX-Solver results file. The mesh from the CFX-Solver input file is used
unless the |
|
|
Uses initial values and continues the run from the most recent
results for the named configuration. The mesh from the configuration
(.cfg) file is used unless the
|
|
|
Uses |
|
|
(UNIX only) Uses the X11 server |
|
|
Starts the double-precision version of Ansys CFX Partitioner,
Interpolator and Solver. Also see the |
|
|
Starts the CFX-Solver using one of the example CFX-Solver input files
provided with the product. The example
|
|
|
Specifies the basename for the CFX-Solver Output file, CFX-Solver Results
file, and the temporary directory based on <name>
instead of the CFX-Solver input file name. No numerical suffix (such as
|
|
|
Displays the help information for command-line options. |
|
|
Uses the initial values in the CFX-Solver results file
|
|
|
Uses initial values from the most recent results for the named
configuration as a basic initial guess for the run. The run history
from this file is discarded. The mesh from this results file is used
unless the |
|
|
Uses initial values from the specified CFX-Solver Results file as a
basic initial guess for the run. The run history from this file is
discarded. The mesh from the configuration
(.cfg) file or the CFX-Solver input file is
used unless the |
|
|
Starts CFX-Solver Manager in graphic user interface (GUI) mode. The CFX-Solver Manager interface enables starting a new run or managing or monitoring an existing run. This option may be combined with specific options only (-chdir -definition -display -eg -monitor -verbose). Other options have no effect. |
|
|
Interpolates the solution from the initial values file, if one is
supplied (using the |
|
|
When running with the solver-based interpolator
( |
|
|
Uses the single precision Ansys CFX Interpolator executable. |
|
|
Uses the large problem Ansys CFX Interpolator executable. |
|
|
When running with the interpolator
( |
|
|
Keeps the .job file after an Ansys CFX Solver run. This file contains a brief summary of various solution values, and is most useful for regression purposes. |
|
|
Keeps job file after an Ansys CFX Partitioner run. This file contains a brief summary of various solution values, and is most useful for regression purposes. |
|
|
Default to the large problem version of the Ansys CFX Partitioner, Interpolator and Solver. |
|
|
Specify a license preference file. |
|
|
Sets the maximum elapsed time (wall clock time) that CFX-Solver will
run. Elapsed time must be in quotes and have correct units in square
brackets. For example: |
|
|
Uses |
|
|
Uses |
|
|
When starting Ansys CFX-Solver Manager, use this option to monitor the run
represented by |
|
|
Treats the CFX-Solver input file as a multi-configuration input file. |
|
|
Specifies the basename for exported files and the temporary
directory based on the problem name This name cannot be set when using the CFX-Solver Manager to start the CFX-Solver. |
|
|
Use this option to preprocess the CFX-Solver input file only, without
running the CFX-Solver executable. When used with a
multi-configuration CFX-Solver input file, this option produces complete
solver input files for the individual configuration
(.cfg) files. When used with the
" |
|
|
Non-Uniform Memory Access (NUMA) is a hardware feature that associates regions of memory with specific groups of CPU cores. Although all memory is generally accessible from any CPU core, the fastest access is to local memory. NUMA memory containment can improve performance by restricting memory access for a solver process to its local memory. If a solver process requires more memory than a single NUMA node can provide, NUMA containment can cause a failure because memory outside the local NUMA node is inaccessible. Parallel runs using relatively few CPU cores, having memory requirements close to the system limit, or widely differing between partitions, may be susceptible to this problem. NUMA memory containment is disabled by default and is not available for the partitioner or interpolator because these run as serial processes that often have a high memory requirement. Failures of this type are likely to be abrupt; as in the event of an ‘out of memory’ condition, the operating system terminates the offending process. Therefore if NUMA containment has been enabled and the solver fails without giving any diagnostics, a repeat run without NUMA containment should be considered.
|
|
|
Run operating point jobs concurrently. The maximum number of concurrent jobs may be optionally specified. If not specified, the number of concurrent jobs is unlimited. |
|
|
Use this option to specify the job summary format in the
CFX-Solver Output file. 0: minimal 1: terse format (default, no information per partition) 2: compact format (one line per partition) 3: verbose format (the default prior to Ansys CFX Release 15.0) |
|
|
Use this option to set the comma-separated
Host details are taken from the hostinfo.ccl
file, if they are there; otherwise, if possible, the required
information will be automatically detected.
|
|
|
When running in parallel, uses the specified host list. See the
|
|
|
When running in parallel, uses only the local host. This will
override the |
|
|
Starts the solver in parallel mode. This option can be combined
with the |
|
|
Specifies the name of an input partition file used to set up a partitioning or parallel run. Note: Only *.par files that are generated in Ansys CFX 12.0 (or later) are supported. For details, see CFX Partition File. |
|
|
When used with a parallel run, saves the partitioning information to a file with the same basename as the results file, and the extension .par. |
|
|
Specifies the name of a partition file to which to write the information from a partitioning run. |
|
|
Starts the solver in partitioning mode. This option should not be used if an existing partition file is also specified. |
|
|
Starts |
|
|
Activates coupled partitioning mode for multidomain problems. This is not activated by default. |
|
|
Activates independent partitioning mode for multidomain problems. This is the default. |
|
|
Starts the large problem partitioner, which can partition problems up to 2^31-1 elements. This partitioner uses 64-bit integer and logical variables so it will allocate more memory than the default partitioning executable. |
|
|
Sets the partitioning mode to use when running the partitioner.
Valid options are Finer control over the partitioning method is available through the Command Language. |
|
|
Starts the solver in partitioning mode only. This is normally
equivalent to |
|
|
Uses the single precision Ansys CFX Partitioner. This is the
default, but is provided for overriding any information that might
be stored in the CFX Command Language dataset in a file from
previous runs. Also see the |
|
|
Enables the specification of a job priority to a solver run; the
allowed values are |
|
|
Host name of a job scheduler 'head node'. If not specified, the local host is assumed. |
|
|
In addition to the files in the working directory, this option also considers results files referenced by initial values files when choosing the numerical suffix (such as _001) added to the run name. |
|
|
Use this option to avoid deleting any temporary files after the run. Normally the standard temporary files created by CFX-Solver are deleted automatically after each run. |
|
|
Use this option to explicitly specify that a serial run is required. This is useful when restarting a run from a results file produced by a parallel run, where this option forces a serial run instead. |
|
|
Starts the single-precision version of the CFX-Solver, Partitioner,
and Interpolator. This is the default, but is provided for
overriding any information that might be stored in the CFX Command
Language dataset in a file from a previous run. Also see the
|
|
|
Changes memory estimates used by the CFX-Solver by a factor of
Further options for controlling the CFX-Solver memory allocation are
available. Execute |
|
|
These flags are for advanced users to change the memory allocation
parameters for the solver. Usually, you should use the
|
|
|
Changes the memory estimates used by the Ansys CFX cclsetup executable by a factor of <factor>. |
|
|
These options are the same as the |
|
|
Changes the memory estimates used by the solver-based interpolator
by a factor of |
|
|
These options are the same as the |
|
|
Uses a maximal memory estimate. This option allocates a fraction of the system
memory (by default 0.8), subject to certain constraints
(for example, an order of magnitude more memory than the default
model based option). |
|
|
This option is similar to the |
|
|
Changes the initial MMS catalogue size estimate used by the
CFX-Solver by a factor of |
|
|
Changes the initial MMS catalogue size estimate used by the
partitioner by a factor of |
|
|
Changes the memory estimates used by the Ansys CFX Partitioner by a
factor of |
|
|
These options are the same as the |
|
|
For SLURM jobs, the required partition. |
|
|
Starts For example: the command-line option The string value for
where |
|
|
Uses the double precision Ansys CFX Solver. |
|
|
Uses the single precision Ansys CFX Solver. |
|
|
Uses the large problem Ansys CFX Solver. |
|
|
Uses the named start method to start the solver. This option
enables you to use different parallel methods, as listed in the
CFX-Solver Manager user interface, instead of the defaults. For parallel runs,
you also need to provide the |
|
|
Set the maximum number of threads used by the interpolator. This option provides the same functionality as set in Threading Control. For details, see Interpolator Tab. |
|
|
Set the number of threads used by the interpolator as a fraction of those available on the current hardware. This option provides the same functionality as set in Threading Control. For details, see Interpolator Tab. |
|
|
For UGE jobs, the required parallel environment. |
|
|
For UGE jobs, the required queue name. |
|
|
Uses the mesh from the source initial values (that is, from a file or configuration) rather than from the solver input file. This is only valid if a single initial-values source is specified. |
|
|
Specifying this option may result in additional output being sent to the standard output file (normally the screen). |
[a] Changes that affect the way that the mesh is defined, or
that affect the way that the physics CCL relates to the
topology of the mesh that is stored in the solver input
file, cannot be made using the -ccl
argument. For example, locators for applying physics cannot
be modified using the -ccl
option. Such
changes can, however, be made in CFX-Pre. For details, see
Solver Tab.