This module provides options for Kestrel grid systems. This contains an optional list of files to copy and an optional list of files to link into each case folder.

A typical example JSON section is showed below.

"Mesh": {
    "LinkFiles": [
        "grid.avm"
    ],
    "CopyFiles": [
        "aux.avm"
    ]
}
See Also:
class cape.pykes.options.meshopts.MeshOpts(*args, **kw)
get_MeshCopyFiles(j=None, i=None, **kw)

Get list of files to copy into case folder

Call:
>>> CopyFiles = opts.get_MeshCopyFiles(j=None, i=None, **kw)
Inputs:
opts: MeshOpts

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:
CopyFiles: {[]} | list[str]

list of files to copy into case folder

get_MeshFiles(**kw)

Return full list of mesh file names

Call:
>>> fnames = opts.get_MeshFiles(**kw)
Inputs:
opts: cape.pyover.options.Options

Options interface

Outputs:
fnames: list[str]

List of mesh file names

Versions:

  • 2015-12-29 @ddalle: v1.0

  • 2023-03-17 @ddalle: v2.0; use OptionsDict

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

Get list of files to link into case folder

Call:
>>> LinkFiles = opts.get_MeshLinkFiles(j=None, i=None, **kw)
Inputs:
opts: MeshOpts

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:
LinkFiles: {[]} | list[str]

list of files to link into case folder

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

Get list of files to copy into case folder

Call:
>>> opts.set_MeshCopyFiles(CopyFiles, j=None, i=None, **kw)
Inputs:
opts: MeshOpts

options interface

CopyFiles: {[]} | list[str]

list of files to copy into case folder

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_MeshLinkFiles(v, j=None, mode=None)

Get list of files to link into case folder

Call:
>>> opts.set_MeshLinkFiles(LinkFiles, j=None, i=None, **kw)
Inputs:
opts: MeshOpts

options interface

LinkFiles: {[]} | list[str]

list of files to link into case folder

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