cape.pycart.options.runControl.RunControl: Run control options

Options interface for aspects of running a case of Cart3D. The settings are read from the "RunControl" of a JSON file, and the contents of this section are written to case.json within each run folder.

This contains options that determine how long the solver is ran (primarily via the "PhaseSequence" and "PhaseIters" options), what basic mode it is run in (such as a submitted or local job or serial or MPI job), and options for command-line options to the Cart3D binaries. There is also an "Archive" section that can be used for copying files and cleaning up after one or more cases have been completed.

This module primarily provides a class pyCart.options.RunControl. Many of the options that are common to all solvers are inherited from cape.cfdx.options.RunControl. This class also has an interface for environment variables and ulimit parameters.

For pyCart, the relevant pyCart binaries, which become sections of the pyCart.options.RunControl class, are intersect, verify, autoInputs, cubes, mgPrep, and flowCart. There is an additional section "Adaptation" used to define Cart3D adaptation inputs and settings for aero.csh.

In particular, all of the commands available to the classes listed below are also available to pyCart.options.runControl.RunControl.

Classes:
See Also:
class cape.pycart.options.runControl.Adaptation

Dictionary-based interfaced for options for Cart3D adaptation

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_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_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_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_jumpstart(i=None)

Return whether or not to “jump start”, i.e. create meshes before running aero.csh.

Call:
>>> js = opts.get_jumpstart()
Inputs:
opts: pyCart.options.Options

Options interface

Outputs:
js: bool

Whether or not to jumpstart

Versions:

  • 2014-12-04 @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_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_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_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

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_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_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_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_jumpstart(js=False, i=None)

Set whether or not to “jump start”, i.e. create meshes before running aero.csh.

Call:
>>> opts.get_jumpstart(js)
Inputs:
opts: pyCart.options.Options

Options interface

js: bool

Whether or not to jumpstart

Versions:

  • 2014-12-04 @ddalle: First version

set_max_nCells(max_nCells=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_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_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_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

class cape.pycart.options.runControl.Environ
class cape.pycart.options.runControl.RunControl(fname=None, **kw)

Dictionary-based interface for options for running Cart3D

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_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_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_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_start(i=None)

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

Not available during aero.csh runs.

Call:
>>> it_start = opts.get_it_start(i=None)
Inputs:
opts: pyCart.options.Options

Options interface

i: int or None

Phase number

Outputs:
it_start: int or list`(:class:`int)

Startup iterations before averaging for phase i

Versions:

  • 2015-12-02 @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_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_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_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_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_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_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_start(it_start=100, i=None)

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

Not available during aero.csh runs.

Call:
>>> opts.set_it_start(it_start)
>>> opts.set_it_start(it_start, i)
Inputs:
opts: pyCart.options.Options

Options interface

it_start: int or list`(:class:`int)

Startup iterations before averaging for phase i

i: int or None

Phase number

Versions:

  • 2015-12-02 @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_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_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

class cape.pycart.options.runControl.adjointCart

Dictionary-based interfaced for options specific to adjointCart

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

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

class cape.pycart.options.runControl.autoInputs

Dictionary-based interface for autoInputs options

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

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

class cape.pycart.options.runControl.cubes

Dictionary-based interface for cubes options

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

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

class cape.pycart.options.runControl.flowCart

Class for flowCart settings

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_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_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_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_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_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_start(i=None)

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

Not available during aero.csh runs.

Call:
>>> it_start = opts.get_it_start(i=None)
Inputs:
opts: pyCart.options.Options

Options interface

i: int or None

Phase number

Outputs:
it_start: int or list`(:class:`int)

Startup iterations before averaging for phase i

Versions:

  • 2015-12-02 @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_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_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_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_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_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_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_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_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_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_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_first_order(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_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_start(it_start=100, i=None)

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

Not available during aero.csh runs.

Call:
>>> opts.set_it_start(it_start)
>>> opts.set_it_start(it_start, i)
Inputs:
opts: pyCart.options.Options

Options interface

it_start: int or list`(:class:`int)

Startup iterations before averaging for phase i

i: int or None

Phase number

Versions:

  • 2015-12-02 @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_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_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_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_robust_mode(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_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_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.runControl.isRK(RK)

Determine if a variable has a value that can be interpreted as a single set of Runge-Kutta stage inputs

Call:
>>> q = isRK(RK)
Inputs:
RK: any

Any variable

Outputs:
q: bool

True unless RK is a list with depth not equal to 2

Versions:

  • 2014-12-17 @ddalle: First version

class cape.pycart.options.runControl.ulimit