decomposePar.C File Reference
Utilities » Parallel

Automatically decomposes a mesh and fields of a case for parallel execution of OpenFOAM. More...

Go to the source code of this file.

Detailed Description

Automatically decomposes a mesh and fields of a case for parallel execution of OpenFOAM.

Original source file decomposePar.C

Usage
decomposePar [OPTIONS]

Options:

  • -allRegions
    Decompose all regions in regionProperties. Does not check for existence of processor*.
  • -case <dir>
    Specify case directory to use (instead of the cwd).
  • -cellDist
    Write the cell distribution as a labelList, for use with 'manual' decomposition method and as a VTK or volScalarField for visualization.
  • -constant
    Include the 'constant/' dir in the times list.
  • -copyUniform
    Copy any uniform directories too.
  • -copyZero
    Copy 0 directory to processor* rather than decompose the fields.
  • -debug-switch <name=val>
    Specify the value of a registered debug switch. Default is 1 if the value is omitted. (Can be used multiple times)
  • -decomposeParDict <file>
    Use specified file for decomposePar dictionary.
  • -dry-run
    Test without writing the decomposition. Changes -cellDist to only write VTK output.
  • -fields
    Use existing geometry decomposition and convert fields only.
  • fileHandler <handler>
    Override the file handler type.
  • -force
    Remove any existing processor subdirectories before decomposing the geometry.
  • -ifRequired
    Only decompose the geometry if the number of domains has changed from a previous decomposition. No processor subdirectories will be removed unless the -force option is also specified. This option can be used to avoid redundant geometry decomposition (eg, in scripts), but should be used with caution when the underlying (serial) geometry or the decomposition method etc. have been changed between decompositions.
  • -info-switch <name=val>
    Specify the value of a registered info switch. Default is 1 if the value is omitted. (Can be used multiple times)
  • -latestTime
    Select the latest time.
  • -lib <name>
    Additional library or library list to load (can be used multiple times).
  • -noFunctionObjects
    Do not execute function objects.
  • -noSets
    Skip decomposing cellSets, faceSets, pointSets.
  • -noZero
    Exclude the 0 dir from the times list.
  • -opt-switch <name=val>
    Specify the value of a registered optimisation switch (int/bool). Default is 1 if the value is omitted. (Can be used multiple times)
  • -region <regionName>
    Decompose named region. Does not check for existence of processor*.
  • -time <ranges>
    Override controlDict settings and decompose selected times. Does not re-decompose the mesh i.e. does not handle moving mesh or changing mesh cases. Eg, ':10,20 40:70 1000:', 'none', etc.
  • -verbose
    Additional verbosity.
  • -doc
    Display documentation in browser.
  • -doc-source
    Display source code in browser.
  • -help
    Display short help and exit.
  • -help-man
    Display full help (manpage format) and exit.
  • -help-notes
    Display help notes (description) and exit.
  • -help-full
    Display full help and exit.

Definition in file decomposePar.C.