controlDict

/*--------------------------------*- C++ -*----------------------------------*\
| =========                 |                                                 |
| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
|  \\    /   O peration     | Version:  v2506                                 |
|   \\  /    A nd           | Website:  www.openfoam.com                      |
|    \\/     M anipulation  |                                                 |
\*---------------------------------------------------------------------------*/
FoamFile
{
    version     2.0;
    format      ascii;
    class       dictionary;
    object      controlDict;
}

// NB: the #functions do not work here
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

Documentation
{
    docBrowser          "firefox -new-tab %f";
    doxySourceFileExt   "_8C.html";

    // Places to search for documentation, http is last in the list
    doxyDocDirs
    (
        "$WM_PROJECT_USER_DIR/html"
        "$WM_PROJECT_DIR/doc/Doxygen/html"
        "https://www.openfoam.com/documentation/guides/latest/api/"
    );
}


InfoSwitches
{
    // The default ASCII write precision
    writePrecision  6;

    // The output level (verbosity) of messages
    //  - 0 : suppress all output
    //  - 1 : normal output
    //  - >= 2 : report source file and line number (default)
    outputLevel     2;

    // Report information as baseIOdictionary are read in
    writeDictionaries 0;

    // Report optional dictionary entries. For value > 1, treat as fatal.
    writeOptionalEntries 0;

    // Write lagrangian "positions" file in v1706 format (and earlier)
    writeLagrangianPositions 1;

    // Report hosts used (parallel)
    // - 0 = none
    // - 1 = per-host-count, but unsorted
    // - 2 = long output with host.pid ...
    writeHosts      1;

    // Report list of roots used (parallel)
    writeRoots      1;

    // Enable job info
    writeJobInfo    0;

    // Style for "ExecutionTime = " output
    // - 0 = seconds (with trailing 's')
    // - 1 = day-hh:mm::ss
    printExecutionFormat 0;

    // Allow profiling
    allowProfiling  1;

    // Allow case-supplied C++ code (#codeStream, codedFixedValue)
    allowSystemOperations   1;

    // Allow space character in fileName (use with caution)
    // Ignored (always 1) for Windows.
    allowSpaceInFileName    0;
}


OptimisationSwitches
{
    // ===========
    // File system
    // ===========

    // Use physical (0) or logical (1) value for the cwd.
    cwd     1;

    // On NFS mounted file system: maximum wait for files to appear/get
    // updated. Set to 0 on distributed case.
    fileModificationSkew 5;

    // How often retest (using above fileModificationSkew) before giving up.
    // Default is 1.
    maxFileModificationPolls 20;

    //- Modification checking:
    //  - timeStamp         : use modification time on file
    //  - inotify           : use inotify framework
    //  - timeStampMaster   : do time stamp (and file reading) only on master.
    //  - inotifyMaster     : do inotify (and file reading) only on master.
    fileModificationChecking timeStampMaster;

    //- Parallel IO file handler
    //  uncollated (default), collated, masterUncollated etc.
    fileHandler uncollated;

    //- collated: thread buffer size for queued file writes.
    //  If set to 0 or not sufficient for the file size, threading is not used.
    //  A special setting is a negative value which assumes the buffer
    //  (sized with magnitude of value) is large enough to hold all
    //  outstanding writes so will not try to initialise the Pstream with
    //  threading support.
    //  Default: 0
    maxThreadFileBufferSize 0;

    //- masterUncollated: non-blocking buffer size.
    //  If the file exceeds this buffer size scheduled transfer is used.
    //  Default: 1e9
    maxMasterFileBufferSize 1e9;

    // Upper limit when bundling off-processor field transfers (ensight).
    // for component-wise transfer (uses float: 4 bytes)
    // Eg, 5M for 50 ranks of 100k cells
    ensight.maxChunk 5000000;


    // =====================
    // MPI/Parallel settings
    // =====================

    // Default communication type (nonBlocking | scheduled | buffered)
    commsType       nonBlocking;

    // Use host/node topology-aware routines
    //  0: disabled
    //  1: split by hostname [default]
    //  2: split by shared
    //  >=4: (debug/manual) split with given number per node
    nodeComms       1;

    // Minimum number of nodes before topology-aware routines are enabled
    //  <= 2 : always
    //  >= 3 : when there are more than N nodes
    nodeComms.min   0;

    // Selection of topology-aware routines (bitmask)
    //  0: disabled [default]
    //  1: broadcast [MPI]
    //  4: gather/all-gather [MPI]
    // 16: combine (reduction) [manual algorithm]
    // 32: mapGather (reduction) [manual algorithm]
    // 64: gatherList/scatterList [manual algorithm]
    topoControl     0;

    // Transfer double as float for processor boundaries. Mostly defunct.
    floatTransfer   0;

    // Min number of processors to change to tree communication
    nProcsSimpleSum 0;

    // MPI buffer size (bytes).
    // Can override with the MPI_BUFFER_SIZE env variable.
    // The default and minimum is (20000000).
    mpiBufferSize   0;

    // Optional max size (bytes) for unstructured data exchanges.
    // In some phases of OpenFOAM it can send over very large data chunks
    // (e.g. in parallel load balancing) and some MPI implementations have
    // problems with this.
    //
    // This tuning parameter specifies the max number of bytes before
    // switching to a multi-pass send/recv
    // (currently only affects PstreamBuffers exchanges).
    //
    //   0 : disabled
    //  >0 : limit exchanges to specified number of bytes
    //  <0 : limit exchanges to INT_MAX minus specified number of bytes
    maxCommsSize    0;

    // Optional (experimental) feature in lduMatrixUpdate
    // to poll (processor) interfaces for individual readiness
    // instead of waiting for all to complete first.
    //   -1 : wait for any requests to finish and dispatch when possible
    //    0 : non-polling
    //   >0 : number of times to poll for requests (and dispatch) before
    //        reverting to non-polling (deprecated)
    nPollProcInterfaces 0;

    // Min number of processors to use non-blocking exchange (NBX) algorithm
    //   >0 : enabled
    nbx.min         0;

    // Additional non-blocking exchange (NBX) tuning parameters (experimental)
    //    0 : none
    //    1 : initial barrier
    nbx.tuning      0;