4.2.8. Options for RunControl
Section¶
The options below are the available options in the RunControl
Section of the pycart.json
control file
- WarmStart: {
False
} |bool
|bool_
whether to warm start a case
- intersect: {
None
} |object
value of option “intersect”
- ulimit: {
None
} |object
value of option “ulimit”
- cubes: {
None
} |object
value of option “cubes”
- nProc: {
None
} |int
|int32
|int64
number of cores/threads to run
- MPI: {
False
} |bool
|bool_
whether or not to run MPI in phase
- Environ: {
None
} |object
value of option “Environ”
- flowCart: {
None
} |object
value of option “flowCart”
- slurm: {
False
} |bool
|bool_
wheter or not to submit jobs with Slurm
- mpicmd:
'mpiexec'
|'mpirun'
MPI executable name
- Adaptive: {
False
} |bool
|bool_
whether or not to use
aero.csh
in phase- Continue: {
True
} |bool
|bool_
whether restarts of same phase can use same job
- PhaseSequence: {
None
} |int
|int32
|int64
list of phase indices to run
- PhaseIters: {
None
} |int
|int32
|int64
check-point iterations for phase j
- verify: {
None
} |object
value of option “verify”
- WarmStartFolder: {
None
} |object
folder from which to get warm-start file
- autoInputs: {
None
} |object
value of option “autoInputs”
- Verbose: {
False
} |bool
|bool_
“RunControl” verbosity flag
- Archive: {
None
} |object
value of option “Archive”
- Adaptation: {
None
} |object
value of option “Adaptation”
- Resubmit: {
False
} |bool
|bool_
whether or not to submit new job at end of phase j
- adjointCart: {
None
} |object
value of option “adjointCart”
- qsub: {
True
} |bool
|bool_
wheter or not to submit jobs with PBS
- aflr3: {
None
} |object
value of option “aflr3”
- PreMesh: {
False
} |bool
|bool_
whether or not to generate volume mesh before submitting
- nIter: {
None
} |int
|int32
|int64
number of iterations to run in phase j
4.2.8.1. Adaptation Options¶
- jumpstart: {
False
} |bool
|bool_
whether to create meshes b4 running
aero.csh
- max_nCells: {
5000000.0
} |int
|int32
|int64
maximum cell count
- final_mesh_xref: {
0
} |int
|int32
|int64
num. of additional adapts using final error map
- ws_it: {
50
} |int
|int32
|int64
number of
flowCart
iters foraero.csh
cycles- etol: {
1e-06
} |float
|float32
target output error tolerance
- apc: {
'a'
} |'p'
adaptation cycle type (adapt/propagate)
- buf: {
1
} |int
|int32
|int64
number of buffer layers
- mesh_growth: {
1.5
} |float
|float32
mesh growth ratio between cycles of
aero.csh
- n_adapt_cycles: {
0
} |int
|int32
|int64
number of Cart3D adaptation cycles in phase
4.2.8.2. Archive Options¶
- ArchiveTemplate: {
'full'
} |str
template for default archive settings
- PreTarDirs: {
[]
} |object
folders to tar before archiving
- PostDeleteFiles: {
[]
} |object
list of files to delete after archiving
- nCheckPoint: {
2
} |int
|int32
|int64
number of check point files to keep
- ArchiveAction:
''
| {'archive'
} |'rm'
|'skeleton'
action to take after finishing a case
- ArchiveExtension: {
'tar'
} |'tgz'
|'bz2'
|'zip'
archive file extension
- ArchiveFiles: {
[]
} |object
files to copy to archive
- ProgressTarGroups: {
[]
} |object
list of file groups to tar while running
- PostDeleteDirs: {
[]
} |object
list of folders to delete after archiving
- ArchiveFolder: {
''
} |str
path to the archive root
- ProgressDeleteFiles: {
[]
} |object
files to delete while still running
- ArchiveFormat:
''
| {'tar'
} |'tgz'
|'bz2'
|'zip'
format for case archives
- PostTarDirs: {
[]
} |object
folders to tar after archiving
- PreDeleteDirs: {
[]
} |object
folders to delete before archiving
- SkeletonDirs: {
None
} |object
folders to keep during skeleton action
- ProgressUpdateFiles: {
[]
} |object
files to delete old versions while running
- RemoteCopy: {
'scp'
} |str
command for archive remote copies
- PreDeleteFiles: {
[]
} |object
files to delete before archiving
- TarAdapt:
'full'
| {'restart'
} |'none'
archive option for adapt folders
- PreUpdateFiles: {
[]
} |object
files to keep n and delete older, b4 archiving
- PostUpdateFiles: {
[]
} |object
globs: keep n and rm older, after archiving
- ArchiveType: {
'full'
} |'partial'
flag for single (full) or multi (sub) archive files
- PostTarGroups: {
[]
} |object
groups of files to tar after archiving
- ProgressDeleteDirs: {
[]
} |object
folders to delete while still running
- PreTarGroups: {
[]
} |object
file groups to tar before archiving
- TarViz:
'full'
| {'restart'
} |'none'
archive option for visualization files
- SkeletonFiles: {
['case.json']
} |object
files to keep during skeleton action
- ProgressArchiveFiles: {
[]
} |object
files to archive at any time
- SkeletonTarDirs: {
[]
} |object
folders to tar before deletion during skeleton
- ProgressTarDirs: {
[]
} |object
folders to tar while running
- SkeletonTailFiles: {
[]
} |object
files to tail before deletion during skeleton
4.2.8.3. adjointCart Options¶
4.2.8.4. autoInputs Options¶
- maxR: {
10
} |int
|int32
|int64
maximum number of cell refinements
- run: {
None
} |bool
|bool_
whether to execute program
- r: {
30.0
} |float
|float16
|float32
|float64
|float128
|int
|int8
|int16
|int32
|int64
|uint8
|uint16
|uint32
|uint64
nominal
autoInputs
mesh radius- nDiv: {
4
} |int
|int32
|int64
number of divisions in background mesh
4.2.8.5. cubes Options¶
- maxR: {
11
} |int
|int32
|int64
maximum number of refinements in
cubes
mesh- run: {
None
} |bool
|bool_
whether to execute program
- b: {
2
} |int
|int32
|int64
number of layers of buffer cells
- pre: {
'preSpec.c3d.cntl'
} |str
value of option “pre”
- a: {
10.0
} |int
|int8
|int16
|int32
|int64
|uint8
|uint16
|uint32
|uint64
|float
|float16
|float32
|float64
|float128
angle threshold [deg] for geom refinement
- sf: {
0
} |int
|int32
|int64
additional levels at sharp edges
- reorder: {
True
} |bool
|bool_
whether to reorder output mesh
4.2.8.6. flowCart Options¶
- mg_fc: {
3
} |int
|int32
|int64
multigrid levels for
flowCart
- run: {
None
} |bool
|bool_
whether to execute program
- robust_mode: {
False
} |bool
|bool_
whether
flowCart
should be run in robust mode- it_fc: {
200
} |int
|int32
|int64
number of
flowCart
iterations- it_sub: {
10
} |int
|int32
|int64
number of subiters for each
flowCart
time step- limiter: {
2
} |int
|int32
|int64
limiter for
flowCart
- cfl: {
1.1
} |float
|float32
nominal CFL number for
flowCart
- y_is_spanwise: {
True
} |bool
|bool_
whether y is spanwise axis for
flowCart
- binaryIO: {
True
} |bool
|bool_
whether
flowCart
is set for binary I/O- fc_stats: {
0
} |int
|int32
|int64
number of iters for iterative or time averaging
- clic: {
True
} |bool
|bool_
whether to write
Components.i.triq
- first_order: {
False
} |bool
|bool_
whether
flowCart
should be run first-order- tm: {
False
} |bool
|bool_
whether
flowCart
is set for cut cell gradient- fmg: {
True
} |bool
|bool_
whether to run
flowCart
w/ full multigrid- buffLim: {
False
} |bool
|bool_
whether
flowCart
will use buffer limits- nOrders: {
12
} |int
|int32
|int64
convergence drop orders of magnitude for early exit
- it_avg: {
0
} |int
|int32
|int64
number of
flowCart
iters b/w.triq
outputs- it_start: {
100
} |int
|int32
|int64
number of
flowCart
iters b4.triq
outputs- checkptTD: {
None
} |int
|int32
|int64
steps between unsteady
flowCart
checkpoints- dt: {
0.1
} |float
|float32
nondimensional physical time step
- fc_clean: {
False
} |bool
|bool_
whether to run relaxation step before time-accurate step
- vizTD: {
None
} |int
|int32
|int64
steps between
flowCart
visualization outputs- tecO: {
True
} |bool
|bool_
whether
flowCart
dumps Tecplot triangulations- RKScheme: {
None
} |str
|list
the Runge-Kutta scheme for a phase
- pmg: {
False
} |bool
|bool_
whether to run
flowCart
w/ poly multigrid- mpi_fc: {
False
} |bool
|bool_
|int
|int8
|int16
|int32
|int64
|uint8
|uint16
|uint32
|uint64
whether or not to run
mpi_flowCart
- unsteady: {
False
} |bool
|bool_
whether to run time-accurate
flowCart
- cflmin: {
0.8
} |float
|float32
min CFL number for
flowCart
4.2.8.7. Environ Options¶
4.2.8.8. aflr3 Options¶
- mdsblf:
0
| {1
} |2
AFLR3 BL spacing thickness factor option
- bli: {
None
} |int
|int32
|int64
number of AFLR3 prism layers
- run: {
None
} |bool
|bool_
whether or not to run AFLR3
- cdfs: {
None
} |float
|float16
|float32
|float64
|float128
|int
|int8
|int16
|int32
|int64
|uint8
|uint16
|uint32
|uint64
AFLR3 geometric growth exclusion zone size
- flags: {
{}
} |dict
AFLR3 options using
-flag val
format- BCFile: {
None
} |str
AFLR3 boundary condition file
- grow: {
None
} |float
|float32
AFLR3 off-body growth rate
- mdf:
1
| {2
} AFLR3 volume grid distribution flag
- blr: {
None
} |float
|float32
AFLR3 boundary layer stretching ratio
- angqbf: {
None
} |float
|float32
AFLR3 max angle on surface triangles
- nqual: {
0
} |int
|int32
|int64
number of AFLR3 mesh quality passes
- angblisimx: {
None
} |float
|float32
AFLR3 max angle b/w BL intersecting faces
- i: {
None
} |str
input file for AFLR3
- blds: {
None
} |float
|float32
AFLR3 initial boundary-layer spacing
- blc: {
None
} |bool
|bool_
AFLR3 prism layer option
- cdfr: {
None
} |float
|float32
AFLR3 max geometric growth rate
- o: {
None
} |str
output file for AFLR3
- keys: {
{}
} |dict
AFLR3 options using
key=val
format
4.2.8.9. intersect Options¶
- T: {
False
} |bool
|bool_
option to also write Tecplot file
Components.i.plt
- v: {
False
} |bool
|bool_
verbose mode
- triged: {
True
} |bool
|bool_
option to use CGT
triged
to clean output file- run: {
None
} |bool
|bool_
whether to execute program
- rm: {
False
} |bool
|bool_
option to remove small triangles from results
- intersections: {
False
} |bool
|bool_
option to write intersections to
intersect.dat
- fast: {
False
} |bool
|bool_
also write unformatted FAST file
Components.i.fast
- ascii: {
None
} |bool
|bool_
flag that input file is ASCII
- cutout: {
None
} |int
|int32
|int64
number of component to subtract
- smalltri: {
0.0001
} |float
|float32
cutoff size for small triangles with rm
- o: {
'Components.i.tri'
} |str
output file for
intersect
- overlap: {
None
} |int
|int32
|int64
perform boolean intersection of this comp number
- i: {
'Components.tri'
} |str
input file to
intersect
4.2.8.10. ulimit Options¶
- r: {
0
} |object
max real-time scheduling priority,
ulimit -r
- q: {
819200
} |object
max bytes in POSIX message queues,
ulimit -q
- c: {
0
} |object
core file size limit,
ulimit -c
- i: {
127556
} |object
max number of pending signals,
ulimit -i
- l: {
64
} |object
max size that may be locked into memory,
ulimit -l
- d: {
'unlimited'
} |object
process data segment limit,
ulimit -d
- f: {
'unlimited'
} |object
max size of files written by shell,
ulimit -f
- s: {
4194304
} |object
stack size limit,
ulimit -s
- x: {
'unlimited'
} |object
max number of file locks,
ulimit -x
- v: {
'unlimited'
} |object
max virtual memory avail to shell,
ulimit -v
- n: {
1024
} |object
max number of open files,
ulimit -n
- m: {
'unlimited'
} |object
max resident set size,
ulimit -m
- t: {
'unlimited'
} |object
max amount of cpu time in s,
ulimit -t
- u: {
127812
} |object
max number of procs avail to one user,
ulimit -u
- p: {
8
} |object
pipe size in 512-byte blocks,
ulimit -p
- e: {
0
} |object
max scheduling priority,
ulimit -e