2.2.1. Optional Command Line Arguments

The table that follows summarizes the most common of the optional command line arguments:

Argument

Description

-batch-gpu|-batch-gpu-rendering|-batch|-batch-software-rendering <filename>.cse [<results file 1>] [<results file 2> ...]

Starts CFD-Post in batch mode, running the session file you enter as an argument.

Options -batch-gpu and -batch-gpu-rendering are equivalent. With either of these options, GPU rendering is used unless compatible GPU hardware is not found, in which case all saved pictures are instead software rendered (by the CPU). GPU rendering uses compatible graphics hardware to produce images quickly with no loss of quality. These options apply to all saved pictures produced by playing the session file.

Options -batch and -batch-software-rendering are equivalent. With either of these options, software rendering is used. Software rendering produces images without requiring graphics hardware. Software rendering can be slower than GPU rendering and does not correctly render some graphics objects (that is, OpenGL shader graphics). These options apply to all saved pictures produced by playing the session file. Note that software rendering does not support transparent backgrounds in saved PNG images.

-gui

Starts CFD-Post in graphical user interface (GUI) mode (the default).

-line

Starts CFD-Post in line interface (CFD-Post command line) mode. This interface will start a command line prompt where you can type CCL commands. Typically you would create a session file using the user interface mode, then make modifications to that file as required.

To start a CCL section, type "e". When done typing CCL commands, type ".e" to process the CCL.

The ability to write and execute CCL is also available in user interface mode through the Command Editor. For details, see Overview of Command Actions.

-remote <host> -port <number> -viewerport <number>

-remote specifies a remote host to run on.

-port specifies the port number for user interface-engine communication.

-viewerport specifies the port for the viewer.

This option also requires the host machine to be running CFD-Post with the -server option.

-report <template> [-name <report name>] [-outdir <dirname>] [<results file 1>] [<results file 2> ...]

Starts CFD-Post in batch mode, loads the results files, then produces a report and exits.

Here, <template> may be one of the following:

  • The word "auto". If you use the word "auto" for a template, then CFD-Post will attempt to find the most suitable built-in template.

  • The name of a registered template, wrapped in quotes. Register a template by running CFD-Post in user interface mode. For details, see Report Templates.

  • The name of a state or session file. If you provide a state file as a template, the results file indicated in the state file, if there is one, will be used when no results file name is provided on the command line.

-local-root <path>

Specify the file path of the CFD-Post installation.

-t <file>.cst

Alternative form: -state <file>.cst

Start CFD-Post and load the state file <file>.cst.

-results <file>.res

Alternative form:-res <file>.res

Start CFD-Post and load the results file <file>.res.

-monitor <file>.dir

Start CFD-Post and begin monitoring the solution in progress.

-multiconfig single|separate|last

Alternative form:-m single|separate|last

Select a multi-configuration load option to control how you load a multi-configuration (.mres) file or a results file (.res) that contains a run history (that is, a file that was produced from a definition file that had its initial values specified from a results file from a previous run and saved to the results file that you are loading). Choose:

  • Single Case to load all configurations of a multi-configuration run as a single case, or all of the results history from a results file that contains a run history. In either case, only one set of results will appear in the viewer, but you can use the timestep selector to move between results. This option is not fully supported.

  • Separate Cases to load all configurations from a multi-configuration run into separate cases. If a results file with run history is loaded, CFD-Post loads the results from this file and the results for any results file in its run history as separate cases. Each result appears as a separate entry in the tree.

  • Last Case to load only the last configuration of a multi-configuration results file, or only the last results from a results file that contains a run history.

-s <file>.cse

Alternative form:-session <file>.cse

Start CFD-Post and load the session file <file>.cse.

-v

Alternative form:-verbose

Display a summary of the currently set environment variables.

-h

Alternative form:-help

Display a full list of all the possible arguments with short descriptions.