-------------
``RunMatrix``
-------------

**Option aliases:**

* *Cols* ? *Keys*
* *Defns* ? *Definitions*
* *JobNameMaxLength* ? *MaxJobNameLength*
* *Replacements* ? *Replace*
* *Subs* ? *RegexSubs*
* *Substitute* ? *RegexSubs*
* *cols* ? *Keys*
* *defns* ? *Definitions*
* *file* ? *File*
* *gas* ? *Freestream*
* *keys* ? *Keys*
* *replace* ? *Replace*
* *replacements* ? *Replace*
* *subs* ? *RegexSubs*
* *substitute* ? *RegexSubs*
* *prefix* ? *Prefix*

**Recognized options:**

*File*: {``None``} | :class:`str`
    run matrix data file name
*Freestream*: {``{}``} | :class:`dict`
    properties of freestream gas model
*GroupMesh*: {``False``} | ``True``
    value of option "GroupMesh"
*GroupPrefix*: {``'Grid'``} | :class:`str`
    default prefix for group folders
*Keys*: {``['mach', 'alpha', 'beta']``} | :class:`list`\ [:class:`str`]
    list of run matrix variables
*MaxJobNameLength*: {``32``} | :class:`int`
    maximum length of PBS/Slurm job name
*Prefix*: {``''``} | :class:`str`
    default prefix for case folders
*RegexSubs*: {``None``} | :class:`ReplaceOpts`
    regular expression substitutions to apply to case name
*Replace*: {``None``} | :class:`ReplaceOpts`
    replacements from one string to another in case name
*Values*: {``{}``} | :class:`dict`
    value of option "Values"

**Subsections:**

.. toctree::
    :maxdepth: 1

    RunMatrix-Definitions