Scroll to navigation

FOAMHELP(1) OpenFOAM Commands Manual FOAMHELP(1)

NAME

foamHelp - part of OpenFOAM (The Open Source CFD Toolbox).

SYNOPSIS

foamHelp [OPTIONS] tool

DESCRIPTION

Valid <tool> options include:

boundary
functionObject
solver NOTE the <tool> must actually appear *before* any options

ARGUMENTS

OPTIONS

Specify case directory to use (instead of the cwd)
Use specified file for decomposePar dictionary
Run in parallel [Parallel option]
Specify alternative mesh region
Display documentation in browser
Display short help and exit
Display full help and exit

ADVANCED OPTIONS

Specify the value of a registered debug switch. Default is 1 if the value is omitted. (Can be used multiple times)
Override the file handler type
Per-host slave root directories for distributed running. The host specification can be a regex. [Parallel option]
Specify the value of a registered info switch. Default is 1 if the value is omitted. (Can be used multiple times)
Additional library or library list to load (can be used multiple times)
Do not execute function objects
Specify the value of a registered optimisation switch (int/bool). Default is 1 if the value is omitted. (Can be used multiple times)
Slave root directories for distributed running [Parallel option]
Display source code in browser
Display full help (manpage format) and exit
Display help notes (description) and exit

SEE ALSO

Online documentation https://www.openfoam.com/documentation/

COPYRIGHT

Copyright © 2018-2019 OpenCFD Ltd.

OpenFOAM- www.openfoam.com