cape.pyover.options.runControl.RunControl: Run control options

Options interface for aspects of running a case of OVERFLOW. The settings are read from the "RunControl" of a JSON file, and the contents of this section are written to case.json within each run folder.

The methods of cape.cfdx.options.runControl.RunControl are also present. These control options such as whether to submit as a PBS job, whether or not to use MPI, etc.

This contains options that determine how long the solver is ran (primarily via the "PhaseSequence" and "PhaseIters" options), what basic mode it is run in (such as a submitted or local job or serial or MPI job), and options for command-line options to the OVERFLOW binaries. There is also an "Archive" section that can be used for copying files and cleaning up after one or more cases have been completed.

This module primarily provides a class pyOver.options.RunControl. Many of the options that are common to all solvers are inherited from cape.cfdx.options.runControl.RunControl. This class also has an interface for environment variables and ulimit parameters.

In particular, all of the commands available to the classes listed below are also available to pyOver.options.runControl.RunControl.

Classes:
See Also:
class cape.pyover.options.runControl.RunControl(fname=None, **kw)

Dictionary-based interface for automated reports

Call:
>>> opts = RunControl(**kw)
Versions:

  • 2016-02-01 @ddalle: First version

get_Prefix(i=None)

Get the project rootname, or file prefix

Call:
>>> fpre = opts.get_Prefix()
Inputs:
opts: pyOver.options.Options

Options interface

Outputs:
fpre: str

Name of OVERFLOW prefix

Versions:

  • 2016-02-01 @ddalle: First version

get_overrun_args(i=None)

Get extra arguments to overrun_cmd

Call:
>>> fargs = opts.get_overrun_args(i)
Inputs:
opts: pyOver.options.Options

Options interface

i: int | None

Phase number

Outputs:
fargs: str

Extra command-line arguments/flags

Versions:

  • 2016-02-02 @ddalle: First version

get_overrun_aux(i=None)

Get auxiliary command-line inputs to overrun

Call:
>>> aux = opts.get_overrun_aux(i=None)
Inputs:
opts: pyOver.options.Options

Options interface

i: int

Phase number

Outputs:
aux: str

String to be given with -aux flag

Versions:

  • 2016-02-01 @ddalle: First version

get_overrun_cmd(i=None)

Get the name of the OVERFLOW binary to run

Call:
>>> fcmd = opts.get_overrun_cmd(i)
Inputs:
opts: pyOver.options.Options

Options interface

i: int | None

Phase number

Outputs:
fcmd: str

Name of the command-line function to use

Versions:

  • 2016-02-01 @ddalle: First version

get_overrun_kw(i=None)

Get other inputs to overrun

Call:
>>> kw = opts.get_overrun_kw(i=None)
Inputs:
opts: pyOver.options.Options

Options interface

i: int

Phase number

Outputs:
kw: dict

Dictionary of additional arguments to overrun

Versions:

  • 2016-02-01 @ddalle: First version

get_overrun_nthreads(i=None)

Get number of OpenMP threads for overrunmpi

Call:
>>> nt = opts.get_overrun_nthreads(i=None)
Inputs:
opts: pyOver.options.Options

Options interface

i: int | None

Phase number

Outputs:
nt: {None} | int > 0

Number of OpenMP threads

Versions:

  • 2017-04-27 @ddalle: First version

class cape.pyover.options.runControl.overrun

Class for overrun command-line options

get_overrun_args(i=None)

Get extra arguments to overrun_cmd

Call:
>>> fargs = opts.get_overrun_args(i)
Inputs:
opts: pyOver.options.Options

Options interface

i: int | None

Phase number

Outputs:
fargs: str

Extra command-line arguments/flags

Versions:

  • 2016-02-02 @ddalle: First version

get_overrun_aux(i=None)

Get auxiliary command-line inputs to overrun

Call:
>>> aux = opts.get_overrun_aux(i=None)
Inputs:
opts: pyOver.options.Options

Options interface

i: int

Phase number

Outputs:
aux: str

String to be given with -aux flag

Versions:

  • 2016-02-01 @ddalle: First version

get_overrun_cmd(i=None)

Get the name of the OVERFLOW binary to run

Call:
>>> fcmd = opts.get_overrun_cmd(i)
Inputs:
opts: pyOver.options.Options

Options interface

i: int | None

Phase number

Outputs:
fcmd: str

Name of the command-line function to use

Versions:

  • 2016-02-01 @ddalle: First version

get_overrun_kw(i=None)

Get other inputs to overrun

Call:
>>> kw = opts.get_overrun_kw(i=None)
Inputs:
opts: pyOver.options.Options

Options interface

i: int

Phase number

Outputs:
kw: dict

Dictionary of additional arguments to overrun

Versions:

  • 2016-02-01 @ddalle: First version

get_overrun_nthreads(i=None)

Get number of OpenMP threads for overrunmpi

Call:
>>> nt = opts.get_overrun_nthreads(i=None)
Inputs:
opts: pyOver.options.Options

Options interface

i: int | None

Phase number

Outputs:
nt: {None} | int > 0

Number of OpenMP threads

Versions:

  • 2017-04-27 @ddalle: First version