cape.pyfun.options.configopts: FUn3D surface config opts

This module provides options for defining some aspects of the surface configuration for FUN3D. It is mostly the same as

The "Config" section defines which components are requested by FUN3D for iterative force & moment history reporting. For the moment histories, this section also specifies the moment reference points (moment center in FUN3D nomenclature) for each component.

See Also:
class cape.pyfun.options.configopts.ConfigOpts(*args, **kw)
get_ConfigInput(comp)

Return the input for a particular component

Call:
>>> inp = opts.get_ConfigInput(comp)
Inputs:
opts: Options

Options interface

Outputs:
inp: str | list[int]

List of BCs in this component

Versions:

  • 2015-10-20 @ddalle: Version 1.0

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

Get dictionary of component indices for named comps

Call:
>>> Inputs = opts.get_Inputs(j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

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:
Inputs: {None} | dict

dictionary of component indices for named comps

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

Get add to template component_parameters

Call:
>>> KeepTemplateComponents = opts.get_KeepTemplateComponents(j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

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:
KeepTemplateComponents: {False} | object

add to template component_parameters

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

Get template kinetic_data file

Call:
>>> KineticDataFile = opts.get_KineticDataFile(j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

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:
KineticDataFile: {'inputs/kinetic_data'} | str

template kinetic_data file

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

Get template moving_body.input file

Call:
>>> MovingBodyInputFile = opts.get_MovingBodyInputFile(j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

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:
MovingBodyInputFile: {'inputs/moving_body.input'} | str

template moving_body.input file

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

Get template for rubber.data file

Call:
>>> RubberDataFile = opts.get_RubberDataFile(j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

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:
RubberDataFile: {'inputs/rubber.data'} | str

template for rubber.data file

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

Get template species_thermo_data file

Call:
>>> SpeciesThermoDataFile = opts.get_SpeciesThermoDataFile(j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

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:
SpeciesThermoDataFile: {'inputs/species_thermo_data'} | str

template species_thermo_data file

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

Get template for tdata file

Call:
>>> TDataFile = opts.get_TDataFile(j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

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:
TDataFile: {'inputs/tdata'} | str

template for tdata file

set_ConfigInput(comp, inp)

Set the input for a particular component

Call:
>>> opts.set_ConfigInput(comp, nip)
Inputs:
opts: Options

Options interface

inp: str | list[int]

List of BCs in this component

Versions:

  • 2015-10-20 @ddalle: Version 1.0

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

Get dictionary of component indices for named comps

Call:
>>> opts.set_Inputs(Inputs, j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

options interface

Inputs: {None} | dict

dictionary of component indices for named comps

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

Get add to template component_parameters

Call:
>>> opts.set_KeepTemplateComponents(KeepTemplateComponents, j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

options interface

KeepTemplateComponents: {False} | object

add to template component_parameters

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

Get template kinetic_data file

Call:
>>> opts.set_KineticDataFile(KineticDataFile, j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

options interface

KineticDataFile: {'inputs/kinetic_data'} | str

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

Get template moving_body.input file

Call:
>>> opts.set_MovingBodyInputFile(MovingBodyInputFile, j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

options interface

MovingBodyInputFile: {'inputs/moving_body.input'} | str

template moving_body.input 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_RubberDataFile(v, j=None, mode=None)

Get template for rubber.data file

Call:
>>> opts.set_RubberDataFile(RubberDataFile, j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

options interface

RubberDataFile: {'inputs/rubber.data'} | str

template for rubber.data 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_SpeciesThermoDataFile(v, j=None, mode=None)

Get template species_thermo_data file

Call:
>>> opts.set_SpeciesThermoDataFile(SpeciesThermoDataFile, j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

options interface

SpeciesThermoDataFile: {'inputs/species_thermo_data'} | str

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

Get template for tdata file

Call:
>>> opts.set_TDataFile(TDataFile, j=None, i=None, **kw)
Inputs:
opts: ConfigOpts

options interface

TDataFile: {'inputs/tdata'} | str

template for tdata 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