`cape.pycart.options`: Cart3D and pyCart Settings¶

This module provides tools to read, access, modify, and write settings for cape.pycart. The class is based off of the Python built-in dict class, so its default behavior, such as opts['InputCntl'] or opts.get('InputCntl') are also present. In addition, many convenience methods, such as opts.set_it_fc(n), which sets the number of flowCart iterations, are provided.

In addition, this module controls default values of each pyCart parameter in a two-step process. The precedence used to determine what the value of a given parameter should be is below.

Values directly specified in the input file, pyCart.json

Values specified in the default control file, $PYCART/settings/pyCart.default.json

Hard-coded defaults from this module

An instance of this options class is loaded as the attribute opts to any instance of cape.pycart.cntl.Cntl.

>>> import cape.pycart
>>> cntl = pyCart.Cntl()
>>> cntl.opts.get_InputCntl()
u'input.cntl'

This module and the classes it provides are based heavily on the generic version, cape.cfdx.options. In addition, the pyCart.options.Options class inherits methods from the classes in its submodules, such as cape.pycart.options.PBS and cape.pycart.options.RunControl.

See Also:

class cape.pycart.options.Options(fname=None, **kw)¶

Options class for pyCart, subclass of dict

Call:

>>> opts = Options(fname=None, **kw)

Inputs:

fname: str: File to be read as a JSON file with comments
kw: dict: Dictionary to be transformed into pyCart.options.Options

Outputs:

opts: pyCart.options.Options: Options interface

Versions:

2014-07-28 @ddalle: First version

add_ClicForce(comp='entire')¶

Add a component to track using clic

Call:

>>> opts.add_ClicForce(comp)

Inputs:

opts: pyCart.options.Options: Options interface
comp: str | int: Component or list of components

Versions:

2014-12-08 @ddalle: First version

add_LineSensor(name, X)¶

Add an additional line sensor

Call:

>>> opts.add_LineSensor(name, X)

Inputs:

opts: pyCart.options.Options: Options interface
name: str: Name of individual line sensor to extract
X: list (double, len=6): List of start x,y,z and end x,y,z

Versions:

2015-05-06 @ddalle: First version

add_PointSensor(name, X)¶

Add an additional point sensor

Call:

>>> opts.add_PointSensor(name, X)

Inputs:

opts: pyCart.options.Options: Options interface
name: str: Name of individual line sensor to extract
X: list (double, len=3): List of point x,y,z sensors

Versions:

2015-05-07 @ddalle: First version

add_Xslice(x)¶

Add a cutting plane to the current list

Call:

>>> opts.add_Xslice(x)

Inputs:

opts: pyCart.options.Options: Options interface
x: float: Cut plane coordinate

Versions:

2014-10-08 @ddalle: First version

add_Yslice(y)¶

Add a cutting plane to the current list

Call:

>>> opts.add_Yslice(x)

Inputs:

opts: pyCart.options.Options: Options interface
y: float: Cut plane coordinate

Versions:

2014-10-08 @ddalle: First version

add_Zslice(z)¶

Add a cutting plane to the current list

Call:

>>> opts.add_Zslice(z)

Inputs:

opts: pyCart.options.Options: Options interface
z: float: Cut plane coordinate

Versions:

2014-10-08 @ddalle: First version

get_Adaptive(i=None)¶

Return whether or not to use aero.csh

Call:

>>> ac = opts.get_Adaptive(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

ac: bool or list`(:class:`bool): Whether or not to use aero.csh

Versions:

2014-10-03 @ddalle: First version
2015-11-13 @ddalle: use_aero_csh -> Adaptive

get_AeroCsh()¶

Return the name of the master aero.csh file

Call:

>>> fname = opts.get_AeroCsh()

Inputs:

opts: pyCart.options.Options: Options interface

Outputs:

fname: str: Name of Cart3D aero shell template file

Versions:

2014-09-30 @ddalle: First version

get_BBox()¶

Return the list of bounding boxes for volume mesh creation

There are two methods to specify a "BBox". The first is to give the name of a component taken from a Cart3d Config.xml file. The cape.tri.Tri class automatically finds the smallest bounding box that contains this component, and then the user can specify additional margins beyond this box (margins can also be negative). In addition, separate margins (or “pads”) on the minimum and maximum coordinates can be given following the convention "xm" (short for x-minus) on the minimum coordinate and "xp" for the maximum coordinate.

{
    "compID": "fin2",
    "n": 9,
    "pad": 2.0,
    "xpad": 3.0,
    "ym": -1.0,
    "yp": 3.0
}

The other method is to simply give the limits as a list of xmin, xmax, ymin, … In both methods n is the number of refinements to specify within the bounding ox.

{
    "n": 9,
    "xlim": [10.0, 13.5, 3.0, 3.7, -0.8, 0.8]
}

Call:

>>> BBox = opts.get_BBox()

Inputs:

opts: pyCart.options.Options: Options interface

Outputs:

BBox: list (dict): List of bounding box specifications

See Also:

cape.tri.TriBase.GetCompBBox()
pyCart.options.runControl.cubes
pyCart.preSpecCntl.PreSpecCntl

Versions:

2014-10-08 @ddalle: First version

get_ClicForces(i=None)¶

Get force or list of forces requested to track using clic

Call:

>>> comp = opts.get_ClicForces(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: None | int | list`(:class:`int): Index of component in list to return

Outputs:

comp: str | int | list: Component or list of components to track with clic

Versions:

2014-12-08 @ddalle: First version

get_ComponentGamma(comp)¶

Get the Mach number option for a data book group

Mostly used for line loads; coefficients require Mach number

Call:

>>> o_mach = opts.get_ComponentMach(comp)

Inputs:

opts: pyCart.options.Options: Options interface
comp: str: Name of line load group

Outputs:

o_mach: str | float: RunMatrix key to use as Mach number or fixed value

Versions:

2015-09-15 @ddalle: First version

get_ComponentMach(comp)¶

Get the Mach number option for a data book group

Mostly used for line loads; coefficients require Mach number

Call:

>>> o_mach = opts.get_ComponentMach(comp)

Inputs:

opts: pyCart.options.Options: Options interface
comp: str: Name of line load group

Outputs:

o_mach: str | float: RunMatrix key to use as Mach number or fixed value

Versions:

2015-09-15 @ddalle: First version

get_ComponentReynoldsNumber(comp)¶

Get the Reynolds number option for a data book group

Mostly used for line loads; coefficients require Mach number

Call:

>>> o_re = opts.get_ComponentReynoldsNumber(comp)

Inputs:

opts: pyCart.options.Options: Options interface
comp: str: Name of line load group

Outputs:

o_mach: str | float: RunMatrix key to use as Reynolds number or fixed value

Versions:

2015-09-15 @ddalle: First version

get_GroupMesh()¶

Determine whether or not groups have common meshes

Call:

>>> qGM = opts.get_GroupMesh()

Inputs:

opts pyCart.options.Options: Options interface

Outputs:

qGM: bool: True all cases in a group use the same (starting) mesh

Versions:

2014-10-06 @ddalle: First version

get_InputCntl()¶

Return the name of the master input.cntl file

Call:

>>> fname = opts.get_InputCntl()

Inputs:

opts: pyCart.options.Options: Options interface

Outputs:

fname: str: Name of Cart3D input control template file

Versions:

2014-09-30 @ddalle: First version

get_LineSensors(name=None)¶

Get dictionary of line sensors

Call:

>>> LS = opts.get_LineSensors(name=None):

Inputs:

opts: pyCart.options.Options: Options interface
name: str: Name of individual line sensor to extract

Outputs:

LS: dict (dict): Line sensor or dictionary of line sensors

Versions:

2015-05-06 @ddalle: First version

get_PointSensors(name=None)¶

Get dictionary of point sensors

Call:

>>> PS = opts.get_PointSensors(name=None):

Inputs:

opts: pyCart.options.Options: Options interface
name: str: Name of individual line sensor to extract

Outputs:

PS: dict (dict): Point sensor or dictionary of point sensors

Versions:

2015-05-07 @ddalle: First version

get_RKScheme(i=None)¶

Return the Runge-Kutta scheme for a run

Call:

>>> RK = opts.get_RKScheme(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

RK: str or list ([float,:class:int]): Named Runge-Kutta scheme or list of coefficients and gradient evaluation flags

See also:

pyCart.inputCntl.InputCntl.SetRungeKutta()

Versions:

2014-12-17 @ddalle: First version

get_TarAdapt()¶

Return the archive format for adapt folders

Call:

>>> fmt = opts.get_TarAdapt()

Inputs:

opts: pyCart.options.Options: Options interface

Outputs:

fmt: "" | {"tar"} | "gzip" | "bz2": Archive format

Versions:

2015-01-10 @ddalle: First version

get_TarViz()¶

Return the archive format for visualization files

Call:

>>> fmt = opts.get_TarViz()

Inputs:

opts: pyCart.options.Options: Options interface

Outputs:

fmt: "" | {"tar"} | "gzip" | "bz2": Archive format

Versions:

2015-01-10 @ddalle: First version

get_XLev()¶

Return the list of XLev specifications for surface refinements

An XLev specification tells cubes to perform a number of additional refinements on any cut cells that intersect a triangle from a named component. This refinement can violate the maxR command-line input to cubes and is very useful for ensuring that small features of the surface have adequate resolution in the initial volume mesh.

The following example specifies two additional refinements (after the initial run-through by cubes) on all triangles in the component "fins". These instructions are then written to preSpec.c3d.cntl.

{
    "compID": "fins",
    "n": 2
}

Call:

>>> XLev = opts.get_XLev()

Inputs:

opts: pyCart.options.Options: Options interface

Outputs:

XLev: list`(:class:`dict): List of surface refinement specifications

Versions:

2014-10-08 @ddalle: First version

get_Xslices(i=None)¶

Return the list of Xslices for extracting solution cut planes

Call:

>>> x = opts.get_Xslices()
>>> x = opts.get_Xslices(i)

Inputs:

opts: pyCart.options.Options: Options interface
i: int: Index of cut plane coordinate to extract

Outputs:

x: float or list`(:class:`float): Cut plane coordinate(s)

Versions:

2014-10-08 @ddalle: First version

get_Yslices(i=None)¶

Return the list of Yslices for extracting solution cut planes

Call:

>>> y = opts.get_Yslices()
>>> y = opts.get_Yslices(i)

Inputs:

opts: pyCart.options.Options: Options interface
i: int: Index of cut plane coordinate to extract

Outputs:

y: float or list`(:class:`float): Cut plane coordinate(s)

Versions:

2014-10-08 @ddalle: First version

get_Zslices(i=None)¶

Return the list of Zslices for extracting solution cut planes

Call:

>>> z = opts.get_Zslices()
>>> z = opts.get_Zslices(i)

Inputs:

opts: pyCart.options.Options: Options interface
i: int: Index of cut plane coordinate to extract

Outputs:

z: float or list`(:class:`float): Cut plane coordinate(s)

Versions:

2014-10-08 @ddalle: First version

get_abuff(i=None)¶

Get the number of buffer layers

Call:

>>> buf = opts.get_abuff(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

buf: int or list`(:class:`int): Number of buffer layers

Versions:

2014-11-14 @ddalle: First version

get_adj_first_order(i=None)¶

Get whether or not to run adjoins in first-order mode

Call:

>>> adj = opts.set_adj_first_order(i)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

adj: bool or list`(:class:`int): Whether or not to always run adjointCart first-order

Versions:

2014-11-17 @ddalle: First version

get_apc(i=None)¶

Get the adaptation type

Call:

>>> apc = opts.get_apc(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

apc: str or list`(:class:`str): Adaptation cycle type, "a" or "p"

Versions:

2014.08.02 @ddalle: First version

get_autoInputs(j=0)¶

Return whether or not to run autoInputs

Call:

>>> q = opts.get_autoInputs(j=0)

Inputs:

opts: pyCart.options.Options: Options interface
j: int: Phase number

Outputs:

q: bool: Whether or not there are nontrivial autoInputs settings

Versions:

2016-04-06 @ddalle: First version

get_binaryIO(i=None)¶

Return whether or not flowCart is set for binary I/O

Call:

>>> binaryIO = opts.get_binaryIO(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

binaryIO: bool or list`(:class:`bool): Whether or not flowCart is for binary I/O

Versions:

2014.08.02 @ddalle: First version

get_buffLim(i=None)¶

Return whether or not to use buffer limits

Call:

>>> buffLim = opts.get_buffLim(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

buffLim: bool or list`(:class:`bool): Whether or not to use flowCart buffer limits

Versions:

2014-11-21 @ddalle: First version

get_cfl(i=None)¶

Return the nominal CFL number for flowCart

Call:

>>> cfl = opts.get_cfl(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

cfl: float or list`(:class:`float): Nominal CFL number for run i

Versions:

2014.08.02 @ddalle: First version

get_cflmin(i=None)¶

Return the minimum CFL number for flowCart

Call:

>>> cflmin = opts.get_cflmin(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

cfl: float or list`(:class:`float): Minimum CFL number for run i

Versions:

2014.08.02 @ddalle: First version

get_checkptTD(i=None)¶

Return the number of steps between unsteady checkpoints

Call:

>>> checkptTD = opts.get_checkptTD(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

checkptTD: int or list`(:class:`int): Number of unsteady time steps between checkpoints

Versions:

2014-11-28 @ddalle: First version

get_clic(i=None)¶

Get setting for whether or not to write Components.i.triq file

Call:

>>> clic = opts.get_clic(i)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

clic: bool: Whether or not to write Components.i.triq on exit

Versions:

2015-09-14 @ddalle: First version

get_cubes(j=0)¶

Return whether or not to run cubes

Call:

>>> q = opts.get_cubes(j=0)

Inputs:

opts: pyCart.options.Options: Options interface
j: int: Phase number

Outputs:

q: bool: Whether or not there are nontrivial cubes settings

Versions:

2016-04-06 @ddalle: First version

get_cubes_a(i=None)¶

Get the “cubes_a” parameter

Call:

>>> cubes_a = opts.get_cubes_a(i=None):

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

cubes_a: int or list`(:class:`int): Customizable parameter for cubes

Versions:

2014-08-03 @ddalle: First version

get_cubes_b(i=None)¶

Get the “cubes_b” parameter

Call:

>>> cubes_b = opts.get_cubes_b(i=None):

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

cubes_b: int or list`(:class:`int): Customizable parameter for cubes

Versions:

2014-08-03 @ddalle: First version

get_dt(i=None)¶

Return the time-accurate nondimensional physical time step

Call:

>>> dt = opts.get_dt(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

dt: float or list`(:class:`float): Nondimensional physical time step

Versions:

2014-11-28 @ddalle: First version

get_etol(i=None)¶

Return the target output error tolerance

Call:

>>> etol = opts.get_etol(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

etol: float or list`(:class:`float): Output error tolerance

Versions:

2014.08.02 @ddalle: First version

get_fc_clean(i=None)¶

Return whether or not to run an initial relaxation step before starting time-accurate solution

Call:

>>> fc_clean = opts.get_fc_clean(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

fc_clean: bool or list`(:class:`bool): Whether or not to run relaxation step

Versions:

2014-12-01 @ddalle: First version

get_fc_stats(i=None)¶

Get number of iterations to use for iterative or time averaging

Call:

>>> nstats = opts.get_fc_stats(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

nstats: int or list`(:class:`int): Number of iterations to use for averaging (off if 0)

Versions:

2014-12-01 @ddalle: First version

get_final_mesh_xref(i=None)¶

Get the number additional adaptations to perform on final error map

Call:

>>> xref = opts.get_final_mesh_xref(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

xref: int or list`(:class:`int): Number of additional adaptations

Versions:

2014-11-19 @ddalle: First version

get_first_order(i=None)¶

Return whether or not flowCart should be run first-order

Call:

>>> fo = opts.get_first_order(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

fo: int or list`(:class:`int): Switch for running flowCart in first-order mode

Versions:

2014-10-02 @ddalle: First version

get_fmg(i=None)¶

Return whether or not flowCart is set to run full multigrid

Call:

>>> fmg = opts.get_fmg(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

fmg: bool or list`(:class:`bool): Whether or not flowCart is set to run full multigrid

Versions:

2014-11-14 @ddalle: First version

get_inputC3d()¶

Get the cubes input file name if not using autoInputs

Call:

>>> fc3d = opts.get_inputC3d()

Inputs:

opts: pyCart.options.Options: Options interface

Outputs:

fc3d: str: Name of input file

Versions:

2015-11-08 @ddalle: Redone

get_it_ad(i=None)¶

Return the number of iterations for adjointCart

Call:

>>> it_fc = opts.get_it_fc(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

it_ad: int or list`(:class:`int): Number of iterations for run i or all runs if i==None

Versions:

2014.08.01 @ddalle: First version

get_it_avg(i=None)¶

Return the number of iterations between writing triq file for cumulative averaging. If 0, do not perform averaging.

Not available during aero.csh runs.

Call:

>>> it_avg = opts.get_it_avg(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

it_avg: int or list`(:class:`int): Stopping interval between averaging for run i

Versions:

2015-09-14 @ddalle: First version

get_it_fc(i=None)¶

Return the number of iterations for flowCart

Call:

>>> it_fc = opts.get_it_fc(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

it_fc: int or list`(:class:`int): Number of iterations for run i or all runs if i==None

Versions:

2014-08-01 @ddalle: First version

get_it_sub(i=None)¶

Return the number of subiterations to perform at each time step

Call:

>>> it_sub = opts.get_it_sub(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

it_sub: int | list[int]: Number of subiterations

Versions:

2014-11-28 @ddalle: First version
2015-11-09 @ddalle: nSteps –> it_sub

get_limiter(i=None)¶

Return the limiter flowCart

Call:

>>> limiter = opts.get_limiter(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

limiter: int or list`(:class:`int): Limiter ID for flowCart

Versions:

2014.08.02 @ddalle: First version

get_maxR(i=None)¶

Get the number of refinements

Call:

>>> maxR = opts.get_maxR(i=None):

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

maxR: int or list`(:class:`int): (Maximum) number of refinements for initial mesh

Versions:

2014-08-03 @ddalle: First version

get_max_nCells(i=None)¶

Return the maximum cell count

Call:

>>> max_nCells = opts.get_max_nCells(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

etol: float or list`(:class:`float): Output error tolerance

Versions:

2014.08.02 @ddalle: First version

get_mesh2d(i=None)¶

Get the two-dimensional mesh status

Call:

>>> mesh2d = opts.get_mesh2d(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Run index

Outputs:

mesh2d: bool or list`(:class:`bool): Two-dimensional if True, three-dimensional otherwise

Versions:

2014-08-03 @ddalle: First version

get_mesh_growth(i=None)¶

Get the refinement cell count ratio

Call:

>>> mesh_growth = opts.get_mesh_growth(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

mesh_growth: float or list`(:class:`float): Refinement mesh growth ratio

Versions:

2014.08.02 @ddalle: First version

get_mg(i=None)¶

Return the number of multigrid levels

Call:

>>> mg = opts.get_mg(i=None) 

Inputs:

opts: pyCart.options.Options: Options interface
i: int: Run index

Outputs:

mg: int: Maximum of mg_fc and mg_ad

Versions:

2014-08-01 @ddalle: First version

get_mg_ad(i=None)¶

Return the number of multigrid levels for adjointCart

Call:

>>> mg_fc = opts.get_mg_ad(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

mg_fc: int or list`(:class:`int): Multigrid levels for run i or all runs if i==None

Versions:

2014.08.02 @ddalle: First version

get_mg_fc(i=None)¶

Return the number of multigrid levels for flowCart

Call:

>>> mg_fc = opts.get_mg_fc(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

mg_fc: int or list`(:class:`int): Multigrid levels for run i or all runs if i==None

Versions:

2014.08.02 @ddalle: First version

get_nCheckPoint(i=None)¶

Return the number of check point files to keep

Call:

>>> nchk = opts.get_nCheckPoint(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int: Phase number

Outputs:

nchk: int: Number of check files to keep (all if 0)

Versions:

2015-01-10 @ddalle: First version

get_nDiv(i=None)¶

Get the number of divisions in background mesh

Call:

>>> nDiv = opts.get_nDiv(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

nDiv: int or list`(:class:`int): Number of background mesh divisions

Versions:

2014-12-02 @ddalle: First version

get_nOrders(i=None)¶

Get the number of orders of convergence for early termination

Call:

>>> nOrders = opts.get_nOrders(i)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

nOrders: int: Number of orders for convergence

Versions:

2014-12-12 @ddalle: First version

get_n_adapt_cycles(i=None)¶

Return the number of Cart3D number of adaptation cycles

Call:

>>> nAdapt = opts.get_n_adapt_cycles(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

nAdapt: int or list`(:class:`int): Number of adaptation cycles

Versions:

2014.08.02 @ddalle: First version

get_optForces()¶

Return a list of output forces to be used in functional

An output force has the following parameters:

type: {"optForce"}
Output type

compID: str | int
Name of component from which to calculate force/moment

force: {0} | 1 | 2
Axis number of force to use (0-based)

frame: {0} | 1
Force frame; 0 for body axes and 1 for stability axes

weight: {1.0} | float
Weight multiplier for force’s contribution to total

J: {0} | 1
Modifier for the force; not normally used

N: {1} | int
Exponent on force coefficient

target: {0.0} | float
Target value; functional is weight*(F-target)**N

Call:

>>> optForces = opts.get_optForces()

Inputs:

opts: pyCart.options.Options: Options interface

Outputs:

optForces: list (dict): List of output force dictionaries

Versions:

2014-11-19 @ddalle: First version

get_optMoments()¶

Return a list of moment coefficients to be used in functional

An output force has the following parameters:

type: {"optMoment""} | "optMoment_point"
Output type

compID: str | int
Name of component from which to calculate force/moment

force: {0} | 1 | 2
Axis number of force to use (0-based)

frame: {0} | 1
Force frame; 0 for body axes and 1 for stability axes

weight: {1.0} | float
Weight multiplier for force’s contribution to total

J: {0} | 1
Modifier for the force; not normally used

N: {1} | int
Exponent on force coefficient

target: {0.0} | float
Target value; functional is weight*(F-target)**N

Call:

>>> optMoments = opts.get_optMoments()

Inputs:

opts: pyCart.options.Options: Options interface

Outputs:

optMoments: list (dict): List of output moment coefficient dictionaries

Versions:

2015-05-14 @ddalle: First version

get_optSensors()¶

Return a list of output sensors to be used in functional

An output sensor has the following parameters. The name of the output sensor defines which point/line sensor is used; therefore it must match exactly a point/line sensor as defined in input.cntl.

type: {"optSensor"}
Output type

weight: {1.0} | float
Weight multiplier for force’s contribution to total

J: {0} | 1
Modifier for the force; not normally used

N: {1} | int
Exponent on force coefficient

target: {0.0} | float
Target value; functional is weight*(F-target)**N

Call:

>>> optSensors = opts.get_optSensors()

Inputs:

opts: pyCart.options.Options: Options interface

Outputs:

optSensors: list (dict): List of output sensor dictionaries

Versions:

2015-05-06 @ddalle: First version

get_pmg(i=None)¶

Return whether or not flowCart is set to run poly multigrid

Call:

>>> fmg = opts.get_pmg(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

pmg: bool or list`(:class:`bool): Whether or not flowCart is set to run poly multigrid

Versions:

2014-11-14 @ddalle: First version

get_preSpecCntl()¶

Return the template preSpec.c3d.cntl file

Call:

>>> fpre = opts.get_preSpecCntl(i=None)

Inputs:

opts: pyCart.options.Options: Options interface

Outputs:

fpre: str: Mesh prespecification file

Versions:

2014-10-08 @ddalle: First version

get_r(i=None)¶

Get the nominal mesh radius

Call:

>>> r = opts.get_r(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

r: float or list`(:class:`float): Nominal mesh radius

Versions:

2014-08-03 @ddalle: First version

get_reorder(i=None)¶

Get the cubes reordering status

Call:

>>> reorder = opts.get_reorder(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

reorder: bool or list`(:class:`bool): Reorder status

Versions:

2014-08-03 @ddalle: First version

get_robust_mode(i=None)¶

Return whether or not flowCart should be run in robust mode

Call:

>>> rm = opts.get_robust_mode(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

rm: int or list`(:class:`int): Switch for running flowCart in robust mode

Versions:

2014-11-21 @ddalle: First version

get_sf(i=None)¶

Get the number of additional refinements around sharp edges

Call:

>>> sf = opts.get_sf(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

sf: int or list[int]: Number of additional refinements at sharp edges

Versions:

2014-12-02 @ddalle: First version

get_tecO(i=None)¶

Return whether or not flowCart dumps Tecplot triangulations

Call:

>>> tecO = opts.get_tecO(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

tecO: bool or list`(:class:`bool): Whether or not flowCart dumps Tecplot triangulations

Versions:

2014.09.07 @ddalle: First version

get_tm(i=None)¶

Return whether or not flowCart is set for cut cell gradient

Call:

>>> tm = opts.get_tm(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

tm: bool or list`(:class:`bool): Whether or not flowCart is set for cut cell gradient

Versions:

2014.08.02 @ddalle: First version

get_unsteady(i=None)¶

Return whether or not to use time-domain td_flowCart

Call:

>>> td_fc = opts.get_unsteady(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

td_fc: bool or list`(:class:`bool): Whether or not to use td_flowCart -unsteady

Versions:

2014-11-28 @ddalle: First version

get_vizTD(i=None)¶

Return the number of steps between visualization outputs

Call:

>>> vizTD = opts.get_vizTD(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

vizTD: int or list`(:class:`int): Number of unsteady time steps between visualization outputs

Versions:

2014-11-28 @ddalle: First version

get_ws_it(i=None)¶

Get number of flowCart iterations on refined mesh i

Call:

>>> ws_it = opts.get_ws_it(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

ws_it: int or list`(:class:`int): Number of flowCart iterations

Versions:

2014.08.02 @ddalle: First version

get_y_is_spanwise(i=None)¶

Return whether or not y is the spanwise axis for flowCart

Call:

>>> y_is_spanwise = opts.get_y_is_spanwise(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

y_is_spanwise: bool or list`(:class:`bool): Whether or not y is the spanwise index flowCart

Versions:

2014.08.02 @ddalle: First version

set_Adaptive(ac=False, i=None)¶

Return whether or not to use aero.csh

Call:

>>> opts.set_Adaptive(ac, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

ac: bool or list`(:class:`bool): Whether or not to use aero.csh

Versions:

2014-10-03 @ddalle: First version
2015-11-13 @ddalle: use_aero_csh -> Adaptive

set_AeroCsh(fname)¶

Set the name of the master aero.csh file

Call:

>>> opts.set_AeroCsh(fname)

Inputs:

opts: pyCart.options.Options: Options interface
fname: str: Name of Cart3D asero shell template file

Versions:

2014-09-30 @ddalle: First version

set_BBox(BBox=None)¶

Set the list of bounding boxes

Call:

>>> opts.set_BBox(BBox)

Inputs:

opts: pyCart.options.Options: Options interface
BBox: list`(:class:`dict): List of bounding box specifications

Versions:

2014-10-08 @ddalle: First version

set_ClicForces(comp='entire', i=None)¶

Set force or list of forces by index to track using clic

Call:

>>> opts.set_ClicForces(comp, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
comp: str | int | list: Component or list of components to track with clic
i: None | int | list`(:class:`int): Index of component in list to return

Versions:

2014-12-08 @ddalle: First version

set_GroupMesh(qGM=False)¶

Specify that groups do or do not use common meshes

Call:

>>> opts.get_GroupMesh(qGM)

Inputs:

opts pyCart.options.Options: Options interface
qGM: bool: True all cases in a group use the same (starting) mesh

Versions:

2014-10-06 @ddalle: First version

set_InputCntl(fname)¶

Set the name of the master input.cntl file

Call:

>>> opts.set_InputCntl(fname)

Inputs:

opts: pyCart.options.Options: Options interface
fname: str: Name of Cart3D input control template file

Versions:

2014-09-30 @ddalle: First version

set_LineSensors(LS={}, name=None, X=[])¶

Set dictionary of line sensors or individual line sensor

Call:

>>> opts.set_LineSensors(LS={})
>>> opts.set_LineSensors(name=None, X=[])

Inputs:

opts: pyCart.options.Options: Options interface
name: str: Name of individual line sensor to set
X: list (double, len=6): List of start x,y,z and end x,y,z
LS: dict (dict): Line sensor or dictionary of line sensors

Versions:

2015-05-06 @ddalle: First version

set_PointSensors(PS={}, name=None, X=[])¶

Set dictionary of point sensors or individual point sensor

Call:

>>> opts.set_PointSensors(LS={})
>>> opts.set_PointSensors(name=None, X=[])

Inputs:

opts: pyCart.options.Options: Options interface
name: str: Name of individual line sensor to set
X: list (double, len=3): List of point x,y,z coordinates
PS: dict (dict): Point sensor or dictionary of point sensors

Versions:

2015-05-07 @ddalle: First version

set_RKScheme(RK=None, i=None)¶

Set the Runge-Kutta scheme for a run

Call:

>>> opts.set_RKScheme(RK, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
RK: str or list ([float,:class:int]): Named Runge-Kutta scheme or list of coefficients and gradient evaluation flags
i: int or None: Phase number

See also:

pyCart.inputCntl.InputCntl.SetRungeKutta()

Versions:

2014-12-17 @ddalle: First version

set_TarAdapt(fmt='tar')¶

Set the archive format for adapt folders

Call:

>>> opts.set_TarAdapt(fmt)

Inputs:

opts: pyCart.options.Options: Options interface
fmt: "" | {"tar"} | "gzip" | "bz2": Archive format

Versions:

2015-01-10 @ddalle: First version

set_TarViz(fmt='tar')¶

Set the archive format for visualization files

Call:

>>> opts.set_TarViz(fmt)

Inputs:

opts: pyCart.options.Options: Options interface
fmt: "" | {"tar"} | "gzip" | "bz2": Archive format

Versions:

2015-01-10 @ddalle: First version

set_XLev(XLev=None)¶

Set the list of XLev specifications

Call:

>>> opts.set_BBox(BBox)

Inputs:

opts: pyCart.options.Options: Options interface
XLev: list`(:class:`dict): List of surface refinement specifications

Versions:

2014-10-08 @ddalle: First version

set_Xslices(x, i=None)¶

Return the list of Xslices for extracting solution cut planes

Call:

>>> x = opts.set_Xslices(x)
>>> x = opts.set_Xslices(x, i)

Inputs:

opts: pyCart.options.Options: Options interface
x: float or list`(:class:`float): Cut plane coordinate(s)
i: int: Index of cut plane coordinate to extract

Versions:

2014-10-08 @ddalle: First version

set_Yslices(y, i=None)¶

Return the list of Yslices for extracting solution cut planes

Call:

>>> y = opts.set_Yslices(x)
>>> y = opts.set_Yslices(x, i)

Inputs:

opts: pyCart.options.Options: Options interface
y: float or list`(:class:`float): Cut plane coordinate(s)
i: int: Index of cut plane coordinate to extract

Versions:

2014-10-08 @ddalle: First version

set_Zslices(z, i=None)¶

Return the list of Zslices for extracting solution cut planes

Call:

>>> x = opts.set_Zslices(z)
>>> x = opts.set_Zslices(z, i)

Inputs:

opts: pyCart.options.Options: Options interface
z: float or list`(:class:`float): Cut plane coordinate(s)
i: int: Index of cut plane coordinate to extract

Versions:

2014-10-08 @ddalle: First version

set_abuff(buf=1, i=None)¶

Set the number of buffer layers

Call:

>>> opts.set_abuff(buf, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
buf: int or list`(:class:`int): Number of buffer layers
i: int or None: Phase number

Versions:

2014-11-14 @ddalle: First version

set_adj_first_order(adj=False, i=None)¶

Set whether or not to run adjoins in first-order mode

Call:

>>> opts.set_adj_first_order(adj, i)

Inputs:

opts: pyCart.options.Options: Options interface
adj: bool or list`(:class:`int): Whether or not to always run adjointCart first-order
i: int or None: Phase number

Versions:

2014-11-17 @ddalle: First version

set_apc(apc='p', i=None)¶

Set the adaptation type

Call:

>>> opts.set_apc(apc, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
apc: str or list`(:class:`str): Adaptation cycle type, "a" or "p"
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

set_binaryIO(binaryIO=True, i=None)¶

Set limiter for flowCart

Call:

>>> opts.set_binaryIO(binaryIO, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
binaryIO: bool or list`(:class:`bool): Whether or not flowCart is set for binary I/O
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

set_buffLim(buffLim=False, i=None)¶

Set flowCart buffer limit setting

Call:

>>> opts.set_buffLim(buffLim, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
buffLim: bool or list`(:class:`bool): Whether or not to use flowCart buffer limits
i: int or None: Phase number

Versions:

2014-11-21 @ddalle: First version

set_cfl(cfl=1.1, i=None)¶

Set nominal CFL number flowCart

Call:

>>> opts.set_mg_fc(mg_fc, i)

Inputs:

opts: pyCart.options.Options: Options interface
cfl: float or list`(:class:`float): Nominal CFL number for run i
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

set_cflmin(cflmin=0.8, i=None)¶

Set minimum CFL number for flowCart

Call:

>>> opts.set_cflmin(cflmin, i)

Inputs:

opts: pyCart.options.Options: Options interface
cflmin: float or list`(:class:`float): Minimum CFL number for run i
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

set_checkptTD(checkptTD=None, i=None)¶

Set the number of steps between unsteady checkpoints

Call:

>>> opts.set_checkptTD(checkptTD, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
checkptTD: int or list`(:class:`int): Number of unsteady time steps between checkpoints
i: int or None: Phase number

Versions:

2014-11-28 @ddalle: First version

set_clic(clic=True, i=None)¶

Get setting for whether or not to write Components.i.triq file

Call:

>>> opts.set_clic(clic, i)

Inputs:

opts: pyCart.options.Options: Options interface
clic: bool: Whether or not to write Components.i.triq on exit
i: int or None: Phase number

Versions:

2015-09-14 @ddalle: First version

set_cubes_a(cubes_a=10, i=None)¶

Set the “cubes_a” parameter

Call:

>>> opts.set_cubes_a(cubes_a, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
cubes_a: int or list`(:class:`int): Customizable parameter for cubes
i: int or None: Phase number

Versions:

2014-08-03 @ddalle: First version

set_cubes_b(cubes_b=2, i=None)¶

Set the “cubes_b” parameter

Call:

>>> opts.set_cubes_b(cubes_b, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
cubes_b: int or list`(:class:`int): Customizable parameter for cubes
i: int or None: Phase number

Versions:

2014-08-03 @ddalle: First version

set_dt(dt=0.1, i=None)¶

Set the time-accurate nondimensional physical time step

Call:

>>> opts.set_dt(dt, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
dt: float | list[float]: Nondimensional physical time step
i: int or None: Phase number

Versions:

2014-11-28 @ddalle: First version

set_etol(etol=1e-06, i=None)¶

Set the output error tolerance

Call:

>>> opts.set_etol(etol, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
etol: float or list`(:class:`float): Output error tolerance
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

set_fc_clean(fc_clean=False, i=None)¶

Set whether or not to run an initial relaxation step before starting time-accurate solution

Call:

>>> opts.set_fc_clean(fc_clean, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
fc_clean: bool or list`(:class:`bool): Whether or not to run relaxation step
i: int or None: Phase number

Versions:

2014-12-01 @ddalle: First version

set_fc_stats(nstats=0, i=None)¶

Get number of iterations to use for iterative or time averaging

Call:

>>> opts.set_fc_stats(nstats, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
nstats: int or list`(:class:`int): Number of iterations to use for averaging (off if 0)
i: int or None: Phase number

Versions:

2014-12-01 @ddalle: First version

set_final_mesh_xref(xref=0, i=None)¶

Set the number additional adaptations to perform on final error map

Call:

>>> opts.set_final_mesh_xref(xref, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
xref: int or list`(:class:`int): Number of additional adaptations
i: int or None: Phase number

Versions:

2014-11-19 @ddalle: First version

set_first_order(fo=0, i=None)¶

Set whether or not flowCart should be run first-order

Call:

>>> opts.set_first_order(fo)
>>> opts.set_first_order(fo, i)

Inputs:

opts: pyCart.options.Options: Options interface
fo: int or list`(:class:`int): Switch for running flowCart in first-order mode
i: int or None: Phase number

Versions:

2014-10-02 @ddalle: First version

set_fmg(fmg=True, i=None)¶

Set full multigrid status for flowCart

Call:

>>> opts.set_fmg(fmg, i)

Inputs:

opts: pyCart.options.Options: Options interface
fmg: bool or list`(:class:`bool): Whether or not flowCart is set to run full multigrid
i: int or None: Phase number

Versions:

2014-11-14 @ddalle: First version

set_inputC3d(fc3d='input.c3d')¶

Set the cubes input file name if not using autoInputs

Call:

>>> opts.set_inputC3d(fc3d)

Inputs:

opts: pyCart.options.Options: Options interface
fc3d: str: Name of input file

Versions:

2015-11-08 @ddalle: Redone

set_it_ad(it_ad=120, i=None)¶

Set the number of iterations for adjointCart

Call:

>>> opts.set_it_ad(it_ad)
>>> opts.set_it_ad(it_ad, i)

Inputs:

opts: pyCart.options.Options: Options interface
it_ad: int or list`(:class:`int): Number of iterations for run i or all runs if i==None
i: int or None: Phase number

Versions:

2014.08.01 @ddalle: First version

set_it_avg(it_avg=0, i=None)¶

Set the number of iterations between writing triq file for cumulative averaging. If 0, do not perform averaging.

Not available during aero.csh runs.

Call:

>>> opts.set_it_avg(it_avg)
>>> opts.set_it_avg(it_avg, i)

Inputs:

opts: pyCart.options.Options: Options interface
it_avg: int or list`(:class:`int): Stopping interval between averaging for run i
i: int or None: Phase number

Versions:

2015-09-14 @ddalle: First version

set_it_fc(it_fc=200, i=None)¶

Set the number of iterations for flowCart

Call:

>>> opts.set_it_fc(it_fc)
>>> opts.set_it_fc(it_fc, i)

Inputs:

opts: pyCart.options.Options: Options interface
it_fc: int or list`(:class:`int): Number of iterations for run i or all runs if i==None
i: int or None: Phase number

Versions:

2014-08-01 @ddalle: First version

set_it_sub(it_sub=10, i=None)¶

Set the number of subiterations to perform at each time step

Call:

>>> opts.set_it_sub(it_sub, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number
it_sub: int | list[int]: Number of subiterations

Versions:

2014-11-28 @ddalle: First version
2015-11-09 @ddalle: nSteps –> it_sub

set_limiter(limiter=2, i=None)¶

Set limiter for flowCart

Call:

>>> opts.set_limiter(limiter, i)

Inputs:

opts: pyCart.options.Options: Options interface
limiter: int or list`(:class:`int): Limiter ID for flowCart
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

set_maxR(maxR=11, i=None)¶

Get the number of refinements

Call:

>>> opts.set_maxR(maxR, i=None):

Inputs:

opts: pyCart.options.Options: Options interface
maxR: int or list`(:class:`int): (Maximum) number of refinements for initial mesh
i: int or None: Phase number

Versions:

2014-08-03 @ddalle: First version

set_max_nCells(etol=5000000.0, i=None)¶

Return the maximum cell count

Call:

>>> max_nCells = opts.get_max_nCells(i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

etol: float or list`(:class:`float): Output error tolerance

Versions:

2014.08.02 @ddalle: First version

set_mesh2d(mesh2d=False, i=None)¶

Set the two-dimensional mesh status

Call:

>>> opts.set_mesh2d(mesh2d, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
mesh2d: bool or list`(:class:`bool): Two-dimensional if True, three-dimensional otherwise
i: int or None: Run index

Versions:

2014-08-03 @ddalle: First version

set_mesh_growth(mesh_growth=1.5, i=None)¶

Set the refinement cell count ratio

Call:

>>> opts.set_mesh_growth(mesh_growth, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
mesh_growth: float or list`(:class:`float): Refinement mesh growth ratio
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

set_mg(mg=3, i=None)¶

Set number of multigrid levels for flowCart and adjointCart

Call:

>>> opts.set_mg(mg, i=None) 

Inputs:

opts: pyCart.options.Options: Options interface
mg: int: Multigrid levels for both adjointCart and flowCart
i: int: Run index

Versions:

2014-08-01 @ddalle: First version

set_mg_ad(mg_ad=3, i=None)¶

Set number of multigrid levels for adjointCart

Call:

>>> opts.set_mg_ad(mg_ad, i)

Inputs:

opts: pyCart.options.Options: Options interface
mg_ad: int or list`(:class:`int): Multigrid levels for run i or all runs if i==None
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

set_mg_fc(mg_fc=3, i=None)¶

Set number of multigrid levels for flowCart

Call:

>>> opts.set_mg_fc(mg_fc, i)

Inputs:

opts: pyCart.options.Options: Options interface
mg_fc: int or list`(:class:`int): Multigrid levels for run i or all runs if i==None
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

set_nCheckPoint(nchk=2, i=None)¶

Set the number of check point files to keep

Call:

>>> opts.set_nCheckPoint(nchk)

Inputs:

opts: pyCart.options.Options: Options interface
nchk: int: Number of check files to keep (all if 0)
i: int: Phase number

Versions:

2015-01-10 @ddalle: First version

set_nDiv(nDiv=4, i=None)¶

Set the number of divisions in background mesh

Call:

>>> opts.set_nDiv(nDiv, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
nDiv: int or list`(:class:`int): Number of background mesh divisions
i: int or None: Phase number

Versions:

2014-12-02 @ddalle: First version

set_nOrders(nOrders=12, i=None)¶

Set the number of orders of convergence for early termination

Call:

>>> opts.set_nOrders(nOrders, i)

Inputs:

opts: pyCart.options.Options: Options interface
nOrders: int: Number of orders for convergence
i: int or None: Phase number

Versions:

2014-12-12 @ddalle: First version

set_n_adapt_cycles(nAdapt=0, i=None)¶

Set the number of Cart3D adaptation cycles

Call:

>>> opts.set_n_adaptation_cycles(nAdapt, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
nAdapt: int or list`(:class:`int): Number of iterations for run i or all runs if i==None
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

set_pmg(pmg=False, i=None)¶

Set poly multigrid status for flowCart

Call:

>>> opts.set_pmg(pmg, i)

Inputs:

opts: pyCart.options.Options: Options interface
pmg: bool or list`(:class:`bool): Whether or not flowCart is set to run poly multigrid
i: int or None: Phase number

Versions:

2014-11-14 @ddalle: First version

set_preSpecCntl(fpre='preSpec.c3d.cntl')¶

Set the template preSpec.c3d.cntl file

Call:

>>> opts.set_preSpecCntl(fpre)

Inputs:

opts: pyCart.options.Options: Options interface
fpre: str: Mesh prespecification file

Versions:

2014-10-08 @ddalle: First version

set_r(r=30.0, i=None)¶

Set the nominal mesh radius

Call:

>>> opts.set_r(r, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
r: float or list`(:class:`float): Nominal mesh radius
i: int or None: Phase number

Versions:

2014-08-03 @ddalle: First version

set_reorder(reorder=True, i=None)¶

Set the cubes reordering status

Call:

>>> opts.set_reorder(reorder, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
reorder: bool or list`(:class:`bool): Reorder status
i: int or None: Phase number

Versions:

2014-08-03 @ddalle: First version

set_robust_mode(rm=0, i=None)¶

Return whether or not flowCart should be run in robust mode

Call:

>>> opts.get_robust_mode(rm, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
rm: int or list`(:class:`int): Switch for running flowCart in robust mode
i: int or None: Phase number

Versions:

2014-11-21 @ddalle: First version

set_sf(sf=0, i=None)¶

Set the number of additional refinements around sharp edges

Call:

>>> opts.set_sf(sf, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
sf: int or list[int]: Number of additional refinements at sharp edges
i: int or None: Phase number

Versions:

2014-12-02 @ddalle: First version

set_tecO(tecO=True, i=None)¶

Set whether flowCart dumps Tecplot triangulations

Call:

>>> opts.set_tecO(tecO, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
tecO: bool or list`(:class:`bool): Whether or not flowCart dumps Tecplot triangulations
i: int or None: Phase number

Versions:

2014.09.07 @ddalle: First version

set_tm(tm=False, i=None)¶

Set cut cell gradient status for flowCart

Call:

>>> opts.set_tm(tm, i)

Inputs:

opts: pyCart.options.Options: Options interface
tm: bool or list`(:class:`bool): Whether or not flowCart is set for cut cell gradient
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

set_unsteady(td_fc=False, i=None)¶

Set whether or not to use time-domain td_flowCart

Call:

>>> opts.set_unsteady(td_fc, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
i: int or None: Phase number

Outputs:

td_fc: bool or list`(:class:`bool): Whether or not to use td_flowCart -unsteady

Versions:

2014-11-28 @ddalle: First version

set_vizTD(vizTD=None, i=None)¶

Set the number of steps between unsteady checkpoints

Call:

>>> opts.set_vizTD(vizTD, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
vizTD: int or list`(:class:`int): Number of unsteady time steps between visualization outputs
i: int or None: Phase number

Versions:

2014-11-28 @ddalle: First version

set_ws_it(ws_it=50, i=None)¶

Set number of flowCart iterations on refined mesh i

Call:

>>> opts.set_ws_it(ws_it, i=None)

Inputs:

opts: pyCart.options.Options: Options interface
ws_it: int or list`(:class:`int): Number of flowCart iterations
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

set_y_is_spanwise(y_is_spanwise=True, i=None)¶

Set limiter for flowCart

Call:

>>> opts.set_y_is_spanwise(y_is_spanwise, i)

Inputs:

opts: pyCart.options.Options: Options interface
y_is_spanwise: bool or list`(:class:`bool): Whether or not y is the spanwise index flowCart
i: int or None: Phase number

Versions:

2014.08.02 @ddalle: First version

`cape.pycart.options`: Cart3D and pyCart Settings¶

Previous topic

Next topic

This Page

cape.pycart.options: Cart3D and pyCart Settings¶

`cape.pycart.options`: Cart3D and pyCart Settings¶