cape.pyover.cntl: OVERFLOW control module

This module provides tools to quickly setup basic or complex OVERFLOW run matrices and serve as an executive for pre-processing, running, post-processing, and managing the solutions. A collection of cases combined into a run matrix can be loaded using the following commands.

>>> import cape.pyover.fun3d
>>> cntl = cape.pyover.cntl.Cntl("pyOver.json")
>>> cntl
<cape.pyover.Cntl(nCase=907)>
>>> cntl.x.GetFullFolderNames(0)
'poweroff/m1.5a0.0b0.0'

An instance of this cape.pyover.cntl.Cntl class has many attributes, which include the run matrix (cntl.x), the options interface (cntl.opts), and optionally the data book (cntl.DataBook), the appropriate input files (such as cntl.Namelist), and possibly others.

Attribute

Class

cntl.x

cape.runmatrix.RunMatrix

cntl.opts

cape.pyover.options.Options

cntl.DataBook

cape.pyover.databook.DataBook

cntl.Namelist

cape.pyover.namelist.Namelist

Finally, the Cntl class is subclassed from the cape.cfdx.cntl.Cntl class, so any methods available to the CAPE class are also available here.

class cape.pyover.cntl.Cntl(fname=None)

Class for handling global options and setup for OVERFLOW

This class is intended to handle all settings used to describe a group of OVERFLOW cases. For situations where it is not sufficiently customized, it can be used partially, e.g., to set up a Mach/alpha sweep for each single control variable setting.

The settings are read from a JSON file, which is robust and simple to read, but has the disadvantage that there is no support for comments. Hopefully the various names are descriptive enough not to require explanation.

Call:
>>> cntl = cape.pyover.Cntl(fname="pyOver.json")
Inputs:
fname: str

Name of cape.pyover input file

Outputs:
cntl: cape.pyfun.cntl.Cntl

Instance of the cape.pyover control class

Data members:
cntl.opts: dict

Dictionary of options for this case (directly from fname)

cntl.x: cape.pyover.runmatrix.RunMatrix

Values and definitions for variables in the run matrix

cntl.Namelist: cape.pyover.overnmlfile.OverNamelist

Interface to over.namelist OVERFLOW input file

cntl.RootDir: str

Absolute path to the root directory

Versions:

  • 2015-10-16 @ddalle: Started

  • 2016-02-02 @ddalle: v1.0

  • 2023-05-31 @jmeeroff: v1.1

ApplyCase(i, nPhase=None, **kw)

Apply settings from cntl.opts to a set of cases

This rewrites each run namelist file and the case.json file in the specified directories.

Call:
>>> cntl.ApplyCase(i, nPhase=None)
Inputs:
cntl: Cntl

Overflow control interface

i: int

Case number

nPhase: {None} | positive int

Last phase number (default determined by PhaseSequence)

Versions:

  • 2014-12-13 @ddalle: v1.0

CheckError(i)

Check if a case has a failure

Call:
>>> q = cntl.CheckError(i)
Inputs:
cntl: Cntl

OVERFLOW control interface

i: int

Run index

Outputs:
q: bool

If True, case has FAIL file in it

Versions:

  • 2015-01-02 @ddalle: v1.0

  • 2017-04-06 @ddalle: Checking for q.bomb

CheckMesh(i: int)

Check if the mesh for case i is prepared

Call:
>>> q = cntl.CheckMesh(i)
Inputs:
cntl: Cntl

Instance of OVERFLOW run control class

i: int

Index of the case to check

Outputs:
q: bool

Whether or not the mesh for case i is prepared

Versions:

  • 2016-02-01 @ddalle: v1.0

CheckNone(v=False)

Check if the current folder has the necessary files to run

Call:
>>> q = cntl.CheckNone(v=False)
Inputs:
cntl: cape.pyfun.cntl.Cntl

Instance of control class containing relevant parameters

v: True | {False}

Verbose flag

Outputs:

q: True | False

Versions:

  • 2015-10-19 @ddalle: v1.0

  • 2017-02-22 @ddalle: v1.1; add v

CheckUsedPhase(i, v=False)

Check maximum phase number run at least once

Call:
>>> j, n = cntl.CheckUsedPhase(i, v=False)
Inputs:
cntl: cape.cfdx.cntl.Cntl

Instance of control class containing relevant parameters

i: int

Index of the case to check (0-based)

v: True | {False}

Verbose flag; prints messages if n is None

Outputs:
j: int | None

Phase number

n: int

Max phase number

Versions:

  • 2017-06-29 @ddalle: v1.0

  • 2017-07-11 @ddalle: v1.1; add v

GetConfig(i)

Get the configuration (if any) for case i

If there is no config or similar run matrix variable, return the name of the group folder

Call:
>>> config = cntl.GetConfig(i)
Inputs:
cntl: Cntl

Instance of cape.pyover control class

i: int

Case index

Outputs:
config: str

Case configuration

Versions:

  • 2016-02-02 @ddalle: v1.0

GetConfigDir(i: int)

Return absolute path to configuration folder

Call:
>>> fcfg = cntl.GetConfigDir(i)
Inputs:
cntl: Cntl

Instance of cape.pyover control class

i: int

Case index

Outputs:
fcfg: str

Full path to configuration folder

Versions:

  • 2016-02-02 @ddalle: v1.0

  • 2023-03-18 @ddalle: v1.1; optdict changes

  • 2023-11-01 @ddalle: v1.2; call setx_i()

GetMeshFileNames(i=None)

Return the list of mesh files

Call:
>>> fname = cntl.GetMeshFileNames()
Inputs:
cntl: cape.pyfun.cntl.Cntl

Instance of control class containing relevant parameters

Outputs:
fname: list[str]

List of file names read from root directory

Versions:

  • 2016-02-01 @ddalle: v1.0

GetNamelistVar(sec, key, j=0)

Get a namelist variable’s value

The JSON file overrides the value from the namelist file

Call:
>>> val = cntl.GetNamelistVar(sec, key, j=0)
Inputs:
cntl: Cntl

Instance of cape.pyover control class

sec: str

Name of namelist section/group

key: str

Variable to read

j: int

Run sequence index

Outputs:
val: int | float | str | list

Value

Versions:

  • 2016-02-01 @ddalle: v1.0

GetPrefix(j=0)

Get the project root name or OVERFLOW file prefix

Call:
>>> name = cntl.GetPrefix(j=0)
Inputs:
cntl: Cntl

Instance of cape.pyover control class

j: int

Phase number

Outputs:
name: str

Project root name

Versions:

  • 2016-02-01 @ddalle: v1.0

GetSurfBCState(key, i, grid=None)

Get stagnation pressure and temperature ratios

Call:
>>> p0, T0 = cntl.GetSurfBC(key, i, grid=None)
Inputs:
cntl: Cntl

Instance of cape.pyover control class

key: str

Name of SurfBC key to process

i: int

Case index

grid: {None} | str

Name of grid for which to extract settings

Outputs:
p0: float

Ratio of BC total pressure to freestream total pressure

T0: float

Ratio of BC total temperature to freestream total temperature

Versions:

  • 2016-08-29 @ddalle: v1.0

GetSurfCTState(key, i, grid=None)

Get stagnation pressure and temp. ratios for SurfCT key

Call:
>>> p0, T0 = cntl.GetSurfCTState(key, i, grid=None)
Inputs:
cntl: Cntl

Instance of cape.pyover control class

key: str

Name of SurfBC key to process

i: int

Case index

grid: {None} | str

Name of grid for which to extract settings

Outputs:
p0: float

Ratio of BC total pressure to freestream total pressure

T0: float

Ratio of BC total temperature to freestream total temperature

Versions:

  • 2016-08-29 @ddalle: v1.0

PrepareCase(i)

Prepare a case for running if it is not already prepared

Call:
>>> cntl.PrepareCase(i)
Inputs:
cntl: cape.pyfun.cntl.Cntl

Instance of control class containing relevant parameters

i: int

Index of case to prepare/analyze

Versions:

  • 2015-10-19 @ddalle: v1.0

PrepareMesh(i: int)

Prepare the mesh for case i if necessary

Call:
>>> cntl.PrepareMesh(i)
Inputs:
cntl: Cntl

Instance of cape.pyover control class

i: int

Case index

Versions:

  • 2016-02-01 @ddalle: v1.0

PrepareNamelist(i, nPhase=None)

Write over.namelist for run case i

The optional input nPhase can be used to right additional phases that are not part of the default PhaseSequence, which can be useful when only a subset of cases in the run matrix will require additional phases.

Call:
>>> cntl.PrepareNamelist(i, nPhase=None)
Inputs:
cntl: Cntl

Instance of OVERFLOW control class

i: int

Run index

nPhase: {None} | positive int

Last phase number (default determined by PhaseSequence)

Versions:

  • 2016-02-01 @ddalle: v1.0

  • 2016-12-13 @ddalle: v1.1; add second input

  • 2022-01-25 @ddalle: v1.2; reread nml each call

ReadCaseNamelist(i: int, j=None)

Read namelist from case i, phase j if possible

Call:
>>> nml = cntl.ReadCaseNamelist(i, rc=None, j=None)
Inputs:
cntl: Cntl

Instance of cape.pyover control class

i: int

Run index

j: {None} | nonnegative int

Phase number

Outputs:
nml: None | OverNamelist

Namelist interface is possible

Versions:

  • 2016-12-12 @ddalle: v1.0

  • 2023-11-06 @ddalle: v2.0; use CaseRunner

ReadNamelist(j=0, q=True)

Read the OVERFLOW namelist template

Call:
>>> cntl.ReadNamelist(j=0, q=True)
Inputs:
cntl: Cntl

Instance of cape.pyover control class

j: int

Phase number

q: bool

Whether or not to read to Namelist, else Namelist0

Versions:

  • 2016-02-01 @ddalle: v1.0

SetSurfBC(key, i, CT=False)

Set a surface BC for one key using IBTYP 153

Call:
>>> cntl.SetSurfBC(key, i, CT=False)
Inputs:
cntl: Cntl

Instance of cape.pyover control class

key: str

Name of SurfBC key to process

i: int

Case index

CT: True | {False}

Whether this key has thrust as input (else p0, T0 directly)

Versions:

  • 2016-08-29 @ddalle: v1.0

StopCases(n=0, **kw)

Stop one or more cases by writing a STOP file

Call:
>>> cntl.StopCases(n=0, cons=[], I=None, **kw)
Inputs:
n: None | {0} | positive int

Iteration at which to stop

cons: list[str]

List of trajectory constraints

I: list[int]

List of case indices

See also:

  • cape.runmatrix.RunMatrix.GetIndices()

Versions:

  • 2017-03-07 @ddalle: v1.0

WriteConfig(i, fname='Config.xml')

Write configuration file

Call:
>>> cntl.WriteConfig(i, fname='Config.xml')
Inputs:
cntl: Cntl

Overflow control interface

i: int

Case index

fname: {'Config.xml'} | str

Name of file to write within run folder

Versions:

  • 2016-08-24 @ddalle: v1.0

cli(*a, **kw)

Command-line interface

Call:
>>> cntl.cli(*a, **kw)
Inputs:
cntl: Cntl

Instance of control class containing relevant parameters

kw: dict (True | False | str)

Unprocessed keyword arguments

Outputs:
cmd: None | str

Name of command that was processed, if any

Versions:

  • 2018-10-19 @ddalle: Content from bin/ executables

init_post()

Do __init__() actions specific to pyover

Call:
>>> cntl.init_post()
Inputs:
cntl: cape.cfdx.cntl.Cntl

CAPE run matrix control instance

Versions:

  • 2023-05-31 @jmeeroff: v1.0