run
Launch OpenFOAM applications or case scripts as background jobs, waiting briefly to report progress or completion; supports MPI parallel cases.
Instructions
Run an OpenFOAM application or case script as a background job; waits briefly and reports the outcome or progress.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| np | No | MPI ranks. >1 runs with mpirun and -parallel, decomposing the case first if needed. | |
| app | Yes | OpenFOAM application (blockMesh, snappyHexMesh, foamRun, simpleFoam, decomposePar, reconstructPar, setFields, ...) or a case script such as Allrun. | |
| log | No | Log file name (default log.<app>; the previous one is kept as .1). | |
| args | No | Command-line arguments, e.g. ['-overwrite'] or ['-dict', 'system/blockMeshDict.fine']. | |
| case | Yes | Case name in the workspace (e.g. 'pitzDaily') or an absolute path inside an allowed root. | |
| wait_seconds | No | How long to wait for completion before returning a job id (default ~45 s). 0 returns immediately. | |
| decompose_method | No | Decomposition method (scotch, hierarchical, simple...) if the case must be decomposed for np>1. Default: the case's decomposeParDict, else scotch. |