freefoam-job(1)

NAME

freefoam-job - Runs a FreeFOAM job in the background

SYNOPSIS

freefoam job [-case <caseDir>] [-s] [-p] [-hosts <hostFile>] [-log <logFile>] [-fg] [-help] <application> [<options>]

DESCRIPTION

Runs the FreeFOAM application <application>. Unless the -fg option is specified, the job is run in the background (this options is ignored if -s is specified). The output is written to the file log, which can be overridden using the -log option. If -s is specified, the output will also be sent to the screen. The -p option will start the application in parallel using the setting of parRunTemplate in the global controlDict (see freefoam(1)). The option -hosts can be used to provide a file containing a list of host names for the parallel run.

OPTIONS

-case <caseDir>: Specify the case directory. Defaults to the current working directory.

-s: Also sends output to screen

-p: Run the job in parallel

-hosts <hostFile>: Specify file with host names

-log <logFile>: Specify logfile name for output, defaults to log

-fg: Run the job in the foreground (i.e. don’t background it). This option is ignored if -s is specified.

-help: Display an option summary

<application>

The application to run

<options>

Options to be passed to <application>

AUTHOR

OpenCFD Ltd.

FREEFOAM

Part of the freefoam(1) suite.