cape.pylch.options.meshopts

This module provides options for surface and volume meshes thar are specific to Loci/CHEM. It is very similar to cape.pyfun.options.meshopts.

  • Provides the name of the .mapbc file using the option MapBCFile. This specifies the boundary condition for each surface component

  • Specifies the name of a volume mesh, MeshFile (which can also be grown from the surface using AFLR3)

  • Specifies a surface triangulation either for creating a volume mesh with AFLR3 and/or providing a surface for thrust BC definitions

See Also:
class cape.pylch.options.meshopts.MeshOpts(*args, **kw)
get_MapBCFile(j=None, i=None, **kw)

Get name of the boundary condition map file

Call:
>>> MapBCFile = opts.get_MapBCFile(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:
MapBCFile: {None} | str

name of the boundary condition map file

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

Get name of the boundary condition map file

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

options interface

MapBCFile: {None} | str

name of the boundary condition map 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