cape.pycart.cmdrun: Cart3D executable interface module

This module provides an interface to the various executables of the Cart3D package. The functions in this module have names that match the command-line names of those Cart3D executables.

See also:
cape.pycart.cmdrun.autoInputs(opts=None, j=0, **kwargs)

Interface to Cart3D executable autoInputs

Call:
>>> autoInputs(opts=opts, j=0, **kw)
Inputs:
opts: Options | dict

Options interface

j: {0} | int

Phase number

r: int

Mesh radius

ftri: str

Name of surface triangulation file

maxR: int

Number of refinements to make

halfBody: True | {False}

Create a half-body mesh that starts at 0 for one axis

symmX

Versions:

  • 2014-09-02 @ddalle: v1.0

  • 2023-08-21 @ddalle: v1.1; use isolate_subsection()

  • 2024-03-05 @ddalle: v1.2; add -halfBody

cape.pycart.cmdrun.cubes(opts=None, j=0, **kwargs)

Interface to Cart3D script cubes

Call:
>>> cubes(opts=opts, j=0, **kw)
Inputs:
j: {0} | int

Phase number

opts: Options | dict

Options interface, run control options instance, raw dict

maxR: int

Number of refinements to make

reorder: bool

Whether or not to reorder mesh

a: int

cubes angle criterion

b: int

Number of buffer layers

sf: int

Number of extra refinements around sharp edges

Versions:

  • 2014-06-30 @ddalle: v1.0

  • 2014-09-02 @ddalle: v2.0; new options paradigm

  • 2014-09-10 @ddalle: v3.0; two modules: cmd, bin

  • 2014-12-02 @ddalle: v3.1; add kwargs, add sf

  • 2023-08-21 @ddalle: v4.0; elim cntl arg, use isolate_()

cape.pycart.cmdrun.flowCart(opts=None, j=0, **kwargs)

Interface to Cart3D executable flowCart

Call:
>>> cmdi = flowCart(opts=None, i=0, **kw)
Inputs:
opts: Options | dict

Options interface

j: {0} | int

Phase number

n: int

Iteration number from which to start (affects -N setting)

clic: bool

Whether or not to create Components.i.triq file

mpi_fc: bool

Whether or not to use MPI version

it_fc: int

Number of iterations to run flowCart

mg_fc: int

Number of multigrid levels to use

it_avg: int

Iterations between averaging break; overrides it_fc

it_start: int

Startup iterations before starting averaging

fmg: bool

Whether to use full multigrid (adds -no_fmg flag if False)

pmg: bool

Whether or not to use poly multigrid

cfl: float

Nominal CFL number

cflmin: float

Minimum CFL number allowed for problem cells or iterations

tm: bool

Whether or not to use second-order cut cells

buffLim: bool

Whether or not to use buffer limiting to smear shocks

binaryIO: bool

Whether or not to use binary format for input/output files

limiter: int

Limiter index

y_is_spanwise: bool

Whether or not to consider angle of attack in z direction

nProc: int

Number of threads to use for flowCart operation

buffLim: bool

Whether or not to use buffer limits for strong off-body shocks

Versions:

  • 2014-09-07 @ddalle: v1.0

  • 2023-08-21 @ddalle: v1.1; use isolate_subsection()

cape.pycart.cmdrun.mgPrep(opts=None, j=0, **kwargs)

Interface to Cart3D executable mgPrep

Call:
>>> mgPrep(opts=None, j=0, **kw)
Inputs:
opts: Options | dict

Options interface

j: {0} | int

Phase number

mg_fc: int

Number of multigrid levels to prepare

Versions:

  • 2014-09-02 @ddalle: v1.0

  • 2023-08-21 @ddalle: v1.1; use isolate_subsection()