cape.pyus.options.runctlopts: US3D run control options

Options interface for aspects of running a case of US3D. 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.runctlopts.RunControlOpts are also present. These control options such as whether to submit as a PBS job, whether or not to use MPI, etc.

See Also:
class cape.pyus.options.runctlopts.RunControlOpts(*args, **kw)

Bases: RunControlOpts

apply_ArchiveTemplate()

Apply named template to set default files to delete/archive

Call:
>>> opts.apply_ArchiveTemplate()
Inputs:
opts: Options

Options interface

Versions:

  • 2016-02-29 @ddalle: v1.0

get_conn(j=None, i=None, **kw)

Get name of connectivity file made by us3d-prepar

Call:
>>> conn = opts.get_conn(j=None, i=None, **kw)
Inputs:
opts: US3DPreparOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
conn: {'conn.h5'} | str

name of connectivity file made by us3d-prepar

get_gas(j=None, i=None, **kw)

Get name of gas model to use for US3D

Call:
>>> gas = opts.get_gas(j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
gas: {None} | str

name of gas model to use for US3D

get_grid(j=None, i=None, **kw)

Get name of US3D grid file

Call:
>>> grid = opts.get_grid(j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
grid: {'grid.h5'} | str

name of US3D grid file

get_input(j=None, i=None, **kw)

Get name of US3D input control file

Call:
>>> input = opts.get_input(j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
input: {'input.inp'} | str

name of US3D input control file

get_run(j=None, i=None, **kw)

Get whether to execute program

Call:
>>> run = opts.get_run(j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
run: {None} | True | False

whether to execute program

set_conn(v, j=None, mode=None)

Get name of connectivity file made by us3d-prepar

Call:
>>> opts.set_conn(conn, j=None, i=None, **kw)
Inputs:
opts: US3DPreparOpts

options interface

conn: {'conn.h5'} | str

name of connectivity file made by us3d-prepar

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar

set_gas(v, j=None, mode=None)

Get name of gas model to use for US3D

Call:
>>> opts.set_gas(gas, j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

gas: {None} | str

name of gas model to use for US3D

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar

set_grid(v, j=None, mode=None)

Get name of US3D grid file

Call:
>>> opts.set_grid(grid, j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

grid: {'grid.h5'} | str

name of US3D grid file

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar

set_input(v, j=None, mode=None)

Get name of US3D input control file

Call:
>>> opts.set_input(input, j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

input: {'input.inp'} | str

name of US3D input control file

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar

set_run(v, j=None, mode=None)

Get whether to execute program

Call:
>>> opts.set_run(run, j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

run: {None} | True | False

whether to execute program

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar

class cape.pyus.options.runctlopts.US3DPreparOpts(*args, **kw)

Bases: ExecOpts

get_conn(j=None, i=None, **kw)

Get name of connectivity file made by us3d-prepar

Call:
>>> conn = opts.get_conn(j=None, i=None, **kw)
Inputs:
opts: US3DPreparOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
conn: {'conn.h5'} | str

name of connectivity file made by us3d-prepar

get_grid(j=None, i=None, **kw)

Get name of input grid to us3d-prepar

Call:
>>> grid = opts.get_grid(j=None, i=None, **kw)
Inputs:
opts: US3DPreparOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
grid: {'pyus.cas'} | str

name of input grid to us3d-prepar

get_run(j=None, i=None, **kw)

Get whether to execute program

Call:
>>> run = opts.get_run(j=None, i=None, **kw)
Inputs:
opts: US3DPreparOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
run: {None} | True | False

whether to execute program

set_conn(v, j=None, mode=None)

Get name of connectivity file made by us3d-prepar

Call:
>>> opts.set_conn(conn, j=None, i=None, **kw)
Inputs:
opts: US3DPreparOpts

options interface

conn: {'conn.h5'} | str

name of connectivity file made by us3d-prepar

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar

set_grid(v, j=None, mode=None)

Get name of input grid to us3d-prepar

Call:
>>> opts.set_grid(grid, j=None, i=None, **kw)
Inputs:
opts: US3DPreparOpts

options interface

grid: {'pyus.cas'} | str

name of input grid to us3d-prepar

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar

set_run(v, j=None, mode=None)

Get whether to execute program

Call:
>>> opts.set_run(run, j=None, i=None, **kw)
Inputs:
opts: US3DPreparOpts

options interface

run: {None} | True | False

whether to execute program

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar

class cape.pyus.options.runctlopts.US3DRunOpts(*args, **kw)

Bases: ExecOpts

get_gas(j=None, i=None, **kw)

Get name of gas model to use for US3D

Call:
>>> gas = opts.get_gas(j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
gas: {None} | str

name of gas model to use for US3D

get_grid(j=None, i=None, **kw)

Get name of US3D grid file

Call:
>>> grid = opts.get_grid(j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
grid: {'grid.h5'} | str

name of US3D grid file

get_input(j=None, i=None, **kw)

Get name of US3D input control file

Call:
>>> input = opts.get_input(j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
input: {'input.inp'} | str

name of US3D input control file

get_run(j=None, i=None, **kw)

Get whether to execute program

Call:
>>> run = opts.get_run(j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

j: {None} | int

Phase index; use None to just return v

i: {None} | int | np.ndarray

opts.x index(es) to use with @expr, @map, etc.

vdef: {None} | object

Manual default

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

ring: {opts._optring[key]} | True | False

Override option to loop through phase inputs

listdepth: {0} | int > 0

Depth of list to treat as a scalar

x: {None} | dict

Ref conditions to use with @expr, @map, etc.; often a run matrix; used in combination with i

sample: {True} | False

Apply j, i, and other settings recursively if output is a list or dict

Outputs:
run: {None} | True | False

whether to execute program

set_gas(v, j=None, mode=None)

Get name of gas model to use for US3D

Call:
>>> opts.set_gas(gas, j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

gas: {None} | str

name of gas model to use for US3D

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar

set_grid(v, j=None, mode=None)

Get name of US3D grid file

Call:
>>> opts.set_grid(grid, j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

grid: {'grid.h5'} | str

name of US3D grid file

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar

set_input(v, j=None, mode=None)

Get name of US3D input control file

Call:
>>> opts.set_input(input, j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

input: {'input.inp'} | str

name of US3D input control file

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar

set_run(v, j=None, mode=None)

Get whether to execute program

Call:
>>> opts.set_run(run, j=None, i=None, **kw)
Inputs:
opts: US3DRunOpts

options interface

run: {None} | True | False

whether to execute program

j: {None} | int

Phase index; use None to just return v

mode: {None} | 0 | 1 | 2 | 3

Warning mode code

0:

no checks

1:

validate silently

2:

validate and show warnings

3:

raise an exception if invalid

listdepth: {0} | int > 0

Depth of list to treat as a scalar