cape.pyfun.options.meshopts

This module provides options for surface and volume meshes thar are specific to FUN3D. This consists of three parts, although the second or third option (but never both) may be optional depending on the configuration.

  • Provides the name of the FUN3D .mapbc file using the option MapBCFile. This specifies the FUN3D 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

The FUN3D version also provides options for Faux and Freeze (or point to an external one) in combination with mesh adaptation.

See Also:
class cape.pyfun.options.meshopts.MeshOpts(*args, **kw)
get_Faux(comp=None)

Get the geometry information for a faux_input component

Call:
>>> faux = opts.get_Faux(comp=None)
Inputs:
opts: cape.cfdx.options.Options

Options interface

comp: {None} | str

Name or number of component to process (all if None)

Outputs:
faux: dict | float | list

faux_input plane definition(s)

Versions:

  • 2017-02-23 @ddalle: v1.0

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

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

Get name of faux_input template file

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

name of faux_input template file

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

Get value of option “FreezeComponents”

Call:
>>> FreezeComponents = opts.get_FreezeComponents(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:
FreezeComponents: {None} | object

value of option “FreezeComponents”

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

Get name of file w/ compIDs to freeze during adaptation

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

name of file w/ compIDs to freeze during adaptation

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

Get name of faux_input template file

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

options interface

FauxFile: {None} | str

name of faux_input template 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_FreezeComponents(v, j=None, mode=None)

Get value of option “FreezeComponents”

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

options interface

FreezeComponents: {None} | object

value of option “FreezeComponents”

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

Get name of file w/ compIDs to freeze during adaptation

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

options interface

FreezeFile: {None} | str

name of file w/ compIDs to freeze during adaptation

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_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