Command-Line Options

<< Click to Display Table of Contents >>

Navigation:  Workflow for a CONVERGE CFD Simulation >

Command-Line Options

CONVERGE accepts a number of command-line options. To invoke an option, append the argument to the CONVERGE executable (e.g., converge-mpich --help on Linux or powershell converge-intelmpi.ps1 --help on Windows).

 

Each version has a slightly different set of options and arguments, as detailed in Tables 5-. There are two options to run CONVERGE using a child license set. The first, and default, option is to use -l base. This option will use a single call to checkout multiple child license. You cannot use a single call to check out child licenses of different version numbers. The second option is to use -l sequential. This option will check out each child licenses individually. By checking out each child license individually you can check out licenses of different version numbers to run the simulation. We do not recommend using the second option unless necessary.

 

Table 5: Command line options for CONVERGE 5.0.0

Argument for CONVERGE 5.0.0

Option description

--help or -h

Show help text.

--version or -v

Show version information.

--license base

or -l base

Run CONVERGE with a base/child license set (default). This option will check out all requested child licenses in a single call.

--license sequential

or -l sequential

Run CONVERGE with a child license set. This option will check out each child license individually.

--license super

or -l super

Run CONVERGE with a single superbase license.

--license restricted

or -l restricted

Run CONVERGE with a single restricted license.

--utility <utility name>

or -u <utility name>

Run the specified utility. Use the --help option to see a list of supported utilities or refer to the CONVERGE 5 Manual for more information.

--output-dir <path>

or -d <path>

Write output to the specified directory.

--serial-output

Write all output files in serial through rank 0. This option might not be available for some simulations. Refer to the CONVERGE 5 Manual for more information.