cape.cfdx.options.meshopts: Basic options for mesh settings

This module provides the class MeshOpts, which reads the settings in the "Mesh" section of the main CAPE control file.

class cape.cfdx.options.meshopts.MeshOpts(*args, **kw)

Dictionary-based interface for Mesh section

Versions:

• 2023-03-16 @ddalle: v1.0

add_CopyAsFiles(val, **kw)

Get file(s) to copy and rename; source file is left-hand side and target file name is right-hand side

Call:

>>> opts.add_CopyAsFiles(CopyAsFiles, **kw)

Inputs:

opts: MeshOpts

options interface

CopyAsFiles: {None} | dict

file(s) to copy and rename; source file is left-hand side and target file name is right-hand side

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

add_CopyFiles(val, **kw)

Get file(s) to copy to run folder w/o changing file name

Call:

>>> opts.add_CopyFiles(CopyFiles, **kw)

Inputs:

opts: MeshOpts

options interface

CopyFiles: {None} | list[str]

file(s) to copy to run folder w/o changing file name

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

add_LinkAsFiles(val, **kw)

Get file(s) to link and rename; source file is left-hand side and target file name is right-hand side

Call:

>>> opts.add_LinkAsFiles(LinkAsFiles, **kw)

Inputs:

opts: MeshOpts

options interface

LinkAsFiles: {None} | dict

file(s) to link and rename; source file is left-hand side and target file name is right-hand side

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

add_LinkFiles(val, **kw)

Get file(s) to link into run folder w/o changing file name

Call:

>>> opts.add_LinkFiles(LinkFiles, **kw)

Inputs:

opts: MeshOpts

options interface

LinkFiles: {None} | list[str]

file(s) to link into run folder w/o changing file name

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

add_LinkMesh(val, **kw)

Get option to link mesh file(s) instead of copying

Call:

>>> opts.add_LinkMesh(LinkMesh, **kw)

Inputs:

opts: MeshOpts

options interface

LinkMesh: {False} | True

option to link mesh file(s) instead of copying

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

add_MeshFile(val, **kw)

Get original mesh file name(s)

Call:

>>> opts.add_MeshFile(MeshFile, **kw)

Inputs:

opts: MeshOpts

options interface

MeshFile: {None} | str

original mesh file name(s)

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

add_TriFile(val, **kw)

Get original surface triangulation file(s)

Call:

>>> opts.add_TriFile(TriFile, **kw)

Inputs:

opts: MeshOpts

options interface

TriFile: {None} | str

original surface triangulation file(s)

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

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

Get file(s) to copy and rename; source file is left-hand side and target file name is right-hand side

Call:

>>> CopyAsFiles = opts.get_CopyAsFiles(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:

CopyAsFiles: {None} | dict

file(s) to copy and rename; source file is left-hand side and target file name is right-hand side

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

Get file(s) to copy to run folder w/o changing file name

Call:

>>> CopyFiles = opts.get_CopyFiles(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: {None} | list[str]

file(s) to copy to run folder w/o changing file name

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

Get file(s) to link and rename; source file is left-hand side and target file name is right-hand side

Call:

>>> LinkAsFiles = opts.get_LinkAsFiles(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:

LinkAsFiles: {None} | dict

file(s) to link and rename; source file is left-hand side and target file name is right-hand side

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

Get file(s) to link into run folder w/o changing file name

Call:

>>> LinkFiles = opts.get_LinkFiles(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: {None} | list[str]

file(s) to link into run folder w/o changing file name

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

Get option to link mesh file(s) instead of copying

Call:

>>> LinkMesh = opts.get_LinkMesh(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:

LinkMesh: {False} | True

option to link mesh file(s) instead of copying

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

Get original mesh file name(s)

Call:

>>> MeshFile = opts.get_MeshFile(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:

MeshFile: {None} | str

original mesh file name(s)

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

Get original surface triangulation file(s)

Call:

>>> TriFile = opts.get_TriFile(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:

TriFile: {None} | str

original surface triangulation file(s)

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

Get file(s) to copy and rename; source file is left-hand side and target file name is right-hand side

Call:

>>> opts.set_CopyAsFiles(CopyAsFiles, j=None, i=None, **kw)

Inputs:

opts: MeshOpts

options interface

CopyAsFiles: {None} | dict

file(s) to copy and rename; source file is left-hand side and target file name is right-hand side

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

Get file(s) to copy to run folder w/o changing file name

Call:

>>> opts.set_CopyFiles(CopyFiles, j=None, i=None, **kw)

Inputs:

opts: MeshOpts

options interface

CopyFiles: {None} | list[str]

file(s) to copy to run folder w/o changing file name

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

Get file(s) to link and rename; source file is left-hand side and target file name is right-hand side

Call:

>>> opts.set_LinkAsFiles(LinkAsFiles, j=None, i=None, **kw)

Inputs:

opts: MeshOpts

options interface

LinkAsFiles: {None} | dict

file(s) to link and rename; source file is left-hand side and target file name is right-hand side

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

Get file(s) to link into run folder w/o changing file name

Call:

>>> opts.set_LinkFiles(LinkFiles, j=None, i=None, **kw)

Inputs:

opts: MeshOpts

options interface

LinkFiles: {None} | list[str]

file(s) to link into run folder w/o changing file name

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

Get option to link mesh file(s) instead of copying

Call:

>>> opts.set_LinkMesh(LinkMesh, j=None, i=None, **kw)

Inputs:

opts: MeshOpts

options interface

LinkMesh: {False} | True

option to link mesh file(s) instead of copying

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

Get original mesh file name(s)

Call:

>>> opts.set_MeshFile(MeshFile, j=None, i=None, **kw)

Inputs:

opts: MeshOpts

options interface

MeshFile: {None} | str

original mesh file name(s)

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

Get original surface triangulation file(s)

Call:

>>> opts.set_TriFile(TriFile, j=None, i=None, **kw)

Inputs:

opts: MeshOpts

options interface

TriFile: {None} | str

original surface triangulation file(s)

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