cape.pyus.inputinpfile: US3D primary input file interface

This is a module built off of the cape.filecntl.FileCntl module customized for manipulating US3D input files. Such files are split into “blocks” with a syntax such as the following:

[CFD_SOLVER]
!-----------------------------------------------------------------------
!   nstop      ires     nplot     iconr      impl      kmax    kmaxo
    30000         0       300       0         21        10       4
!
!   ivisc      ivib     ichem      itrb     ibase   idiss_g
      11          2         1         0         0       1
!
!   ivmod     ikmod     idmod       ikv      icfl     dtfix
        3      -999         3        11         1     0.0d0
!
!  iorder      iuem      ikve       kbl      iman
        2         3        11        80       100
!
!   npfac     npvol
       0         0
!
!     cfl      epsj      wdis
     1.1d0      0.3     0.001d+0
!-----------------------------------------------------------------------
[/CFD_SOLVER]

This module is designed to recognize such sections. The main feature of the module is methods to set specific properties of an input file according to certain named blocks. Most of the parameters occur in ordered sections without labels, and so therefore the contents are quite solver-specific.

class cape.pyus.inputinpfile.InputInp(fname='input.inp')

Bases: Namelist

Input file class for US3D primary input files

This class is derived from the cape.filecntl.FileCntl class, so all methods applicable to that class can also be used for instances of this class.

Call:
>>> inpt = InputInp()
>>> inpt = InputInp(fname)
Inputs:
fname: str

Name of namelist file to read, defaults to 'input.inp'

Outputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

inp.Sections: dict (list[str])

Dictionary of sections containing contents of each namelist

inp.SectionNames: list[str]

List of section names

Version:

  • 2019-06-06 @ddalle: First version

AddSection(sec)

Add a section to the input.inp interface

Call:
>>> inp.AddSection(sec)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Versions:

  • 2016-04-22 @ddalle: First version

  • 2019-06-06 @ddalle: Lightly modified from Namelist

BCNames = []
BCTable = {}
BCTable_rows = 0
BC_Y = {}
BC_cos = {}
CFD_SOLVER_keys = [['nstop', 'ires', 'nplot', 'iconr', 'impl', 'kmax', 'kmaxo'], ['ivisc', 'ivib', 'ichem', 'itrb', 'ibase', 'idiss_g'], ['ivmod', 'ikmod', 'idmod', 'ikv', 'icfl', 'dtfix'], ['iorder', 'iuem', 'ikve', 'kbl', 'iman'], ['npfac', 'npvol'], ['cfl', 'epsj', 'wdis']]
ConvertLineToList(line, **kw)

Convert a line of space-separated values into parts

Call:
>>> header, vals, LV, LS = inp.ConvertLineToList(line, **kw)
Inputs:
line: str

Line of text with space-separated values

indent: {0} | int >= 0

Number of characters to ignore at beginning of line

Outputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

header: str

First indent characters of line

vals: list[str]

List of non-whitespace groups

LV: list[int]

Lengths of strings in vals

LS: list[int]

Lengths of whitespace groups between values

Versions:

  • 2019-06-05 @ddalle: First version

ConvertToText(v, exp='d', fmt='%s')

Convert a value to text to write in the namelist file

Call:
>>> val = inp.ConvertToText(v)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

v: str | int | float | list

Evaluated value of the text

exp: {"d"} | "e" | "E" | "D"

Character to use for exponential notation

fmt: {"%s"} | str

C-style format string

Outputs:
val: str | unicode

Text of the value from file

Versions:

  • 2015-10-16 @ddalle: First version

GetAlpha(name='inflow')

Get angle of attack for specified BC

Call:
>>> alpha = inp.GetAlpha(name="inflow")
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

name: {"inflow"} | str

Name of boundary condition zone

Outputs:
alpha: float

Angle of attack [deg] (0.0 if not specified)

Versions:

  • 2019-06-19 @ddalle: First version

GetBCDirectionCosines(name='inflow', i=None)

Get direction cosine(s) for specified BC

Call:
>>> U = inp.GetBCDirectionCosines(name="inflow")
>>> u = inp.GetBCDirectionCosines(name="inflow", i)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

name: {"inflow"} | str

Name of boundary condition zone

i: {None} | int >= 0 <= i < 3

Axis index

Outputs:
u: float | None

Direction cosine for BC name, index i

U: list[float] (size=3)

Unit vector of direction cosine

Versions:

  • 2019-06-19 @ddalle: First version

GetBCMassFraction(name, i=None)

Get boundary condition mass fraction(s) for specified BC

Call:
>>> Y = inp.GetBCMassFraction(name)
>>> y = inp.GetBCMassFraction(name, i)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

name: str

Name of boundary condition zone

i: {None} | int >= 0

Species index

Outputs:
y: float | None

Mass fraction of species i

Y: list[float]

List of species mass fractions

Versions:

  • 2019-06-06 @ddalle: First version

GetBCParam(name, i=None)

Get value of BC parameter by index

Call:
>>> param = inp.GetBCParam(name, i=None)
*inp*: :class:`cape.pyus.inputinpfile.InputInp`
    Namelist file control instance
*name*: :class:`str`
    Name of boundary condition zone
*i*: {``None``} | :class:`int` >= 0
    Parameter index
Param:
param: str | float | list

Parameter or list of parameters to set

Versions:

  • 2020-04-27 @ddalle: First version

GetBeta(name='inflow')

Get angle of sideslip for specified BC

Call:
>>> beta = inp.GetBeta(name="inflow")
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

name: {"inflow"} | str

Name of boundary condition zone

Outputs:
beta: float

Angle of sideslip [deg] (0.0 if not specified)

Versions:

  • 2019-06-19 @ddalle: First version

GetSectionTable(sec, **kw)

Get entire contents in a table-like space-separated section

Call:
>>> table = inp.GetSectionTable(sec, **kw)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

comment: {"!"} | str

Character denoting start of comment line

skiprows: {0} | int >= 0

Number of non-comment rows to not count towards row

Outputs:
table: list

List of values in each row

See also:
Versions:

  • 2019-06-19 @ddalle: First version

GetSectionTableLines(sec, **kw)

Get indices of lines in a table-like space-separated section

Call:
>>> I = inp.GetSectionTableLines(sec, **kw)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

comment: {"!"} | str

Character denoting start of comment line

skiprows: {0} | int >= 0

Number of non-comment rows to not count towards row

Outputs:
I: list[int]

List of values in each row

See also:
Versions:

  • 2019-06-19 @ddalle: First version

GetSectionTableValue(sec, row, col, vdef=None, **kw)

Get one value in a table-like space-separated section

Call:
>>> inp.GetSectionTableValue(sec, row, col, val, **kw)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

row: int >= 0

Index of non-comment line in section

col: int >= 0

Index of entry in line of text to change/set

vdef: {None} | any

Default value if line needs additional entries

comment: {"!"} | str

Character denoting start of comment line

skiprows: {0} | int >= 0

Number of non-comment rows to not count towards row

Outputs:
val: {vdef} | any

Converted value if found; else vdef

See also:
Versions:

  • 2019-06-06 @ddalle: First version

GetVar(sec, key)

Get value of key from section sec of input.inp

Call:
>>> val = inp.GetVar(sec, key)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

key: str

Name of parameter

Outputs:
val: int | float | None

Value in input.inp file

Versions:

  • 2019-06-27 @ddalle: First version

ReadBCs()

Read boundary condition table

Call:
>>> BCs = inp.ReadBCs()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
BCs: dict

Dictionary of zone, bcn, igrow, name, and params for each boundary condition

Attributes:
inp.BCNames: list[str]

List of boundary condition names

inp.BCTable: BCs

Boundary condition properties

inp.BCTable_rows: int

Number of rows in the BC table section

Versions:

  • 2019-06-06 @ddalle: First version

SetAlpha(alpha, name='inflow')

Set angle of attack for specified BC

Call:
>>> inp.SetAlpha(alpha, name="inflow")
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

name: {"inflow"} | str

Name of boundary condition zone

alpha: float

Angle of attack [deg] (0.0 if not specified)

Versions:

  • 2019-06-19 @ddalle: First version

SetBCDirectionCosines(U, name='inflow', i=None)

Set direction cosine(s) for specified BC

Call:
>>> inp.GetBCDirectionCosines(U, name="inflow")
>>> inp.GetBCDirectionCosines(u, name="inflow", i=None)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

u: float | None

Direction cosine for BC name, index i

U: list[float] (size=3)

Unit vector of direction cosine

name: {"inflow"} | str

Name of boundary condition zone

i: {None} | int >= 0 <= i < 3

Axis index

Versions:

  • 2019-06-19 @ddalle: First version

SetBCIGrow(name, igrow)

Set igrow for a BC by name

Call:
>>> inp.SetBCIGrow(name, igrow)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

name: str

Name of boundary condition zone

igrow: str | int

BC growth parameter

Versions:

  • 2020-04-28 @ddalle: First version

SetBCMassFraction(name, Y, i=None)

Set list of boundary condition mass fraction(s)

Call:
>>> inp.SetBCMassFraction(name, Y)
>>> inp.SetBCMassFraction(name, y, i)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

name: str

Name of boundary condition zone

y: float | None

Mass fraction of species i

Y: list[float]

List of species mass fractions

i: {None} | int >= 0

Species index

Versions:

  • 2019-06-19 @ddalle: First version

SetBCNum(name, bcn)

Set bcn for a BC by name

Call:
>>> inp.SetBCNum(name, bcn)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

name: str

Name of boundary condition zone

bcn: str | int

Boundary condition number

Versions:

  • 2020-04-28 @ddalle: First version

SetBCParam(name, param, i=None)

Set BC “params” for specified BC

Call:
>>> inp.SetBCParam(name, param, i=None)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

name: str

Name of boundary condition zone

param: str | float | list

Parameter or array of parameters to set

i: {None} | int >= 0

Parameter index

Versions:

  • 2019-06-06 @ddalle: First version

SetBCTableParam(name, v, i)

Set BC table parameter

Call:
>>> inp.SetBCTableParam(name, v, i)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

name: str

Name of boundary condition zone

v: str | int

Parameter or string

i: int >= 0

Table column index

Versions:

  • 2020-04-28 @ddalle: First version

SetBCZone(name, zone)

Set zone for a BC by name

Call:
>>> inp.SetBCZone(name, zone)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

name: str

Name of boundary condition zone

zone: str | int

Zone number

Versions:

  • 2020-04-28 @ddalle: First version

SetBeta(beta, name='inflow')

Set angle of sideslip for specified BC

Call:
>>> inp.SetBeta(beta, name="inflow")
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

name: {"inflow"} | str

Name of boundary condition zone

beta: float

Angle of sideslip [deg] (0.0 if not specified)

Versions:

  • 2019-06-19 @ddalle: First version

SetDensity(v, name='inflow')

Set density on inflow boundary condition

Call:
>>> inp.SetDensity(v, name="inflow")
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

v: float | str

Value of freestream density to set

name: {"inflow"} | str

Name of boundary condition zone

Versions:

  • 2020-04-27 @ddalle: First version

SetIGrow(igrow, name='wall')

Set igrow for a BC by name

Call:
>>> inp.SetBCIGrow(name, igrow)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

igrow: str | int

BC growth parameter

name: {"wall"} | str

Name of boundary condition zone

Versions:

  • 2020-04-28 @ddalle: First version

SetIWall(v, name='wall')

Set wall temperature mode on one BC

Call:
>>> inp.SetIWall(v, name="wall")
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

v: int | str

Mode for wall temperature BC

name: {"wall"} | str

Name of boundary condition zone

Versions:

  • 2020-04-28 @ddalle: First version

SetLineValueSequential(line, i, val, **kw)

Set a value in a line that assumes space-separated values

Call:
>>> txt = inp.SetLineValueSequential(line, i, val, **kw)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

line: str

Line of text in space-separated format

i: int >= 0

Index of entry to change/set

val: any

Value to print to entry i of modified line

align: "left" | "center" | {"right"}

Alignment option; determines output spacing

delimiter, delim, sep: {"    " } | str

Separator when line has less than i entries

delim_len: {len(delim)} | int > 0

Number of spaces to use in default delimiter

vdef: {"_"} | str

Default value if line needs additional entries

Outputs:
txt: str

Modified line with entry i set to printed version of val

See also:
Versions:

  • 2019-06-06 @ddalle: First version

SetSectionTable(sec, table, **kw)

Set entire contents in a table-like space-separated section

Call:
>>> inp.SetSectionTable(sec, table, **kw)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

table: list

List of values in each row

comment: {"!"} | str

Character denoting start of comment line

skiprows: {0} | int >= 0

Number of non-comment rows to not count towards row

Versions:

  • 2019-06-19 @ddalle: First version

SetSectionTableValue(sec, row, col, val, **kw)

Set one value in a table-like space-separated section

Call:
>>> inp.SetSectionTableValue(sec, row, col, val, **kw)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

row: int >= 0

Index of non-comment line in section

col: int >= 0

Index of entry in line of text to change/set

val: any

Value to print to entry i of modified line

comment: {"!"} | str

Character denoting start of comment line

skiprows: {0} | int >= 0

Number of non-comment rows to not count towards row

align: "left" | "center" | {"right"}

Alignment option; determines output spacing

delimiter, delim, sep: {"    " } | str

Separator when line has less than i entries

delim_len: {len(delim)} | int > 0

Number of spaces to use in default delimiter

vdef: {"_"} | str

Default value if line needs additional entries

See also:
Versions:

  • 2019-06-06 @ddalle: First version

SetTWall(v, name='wall')

Set wall temperature on one BC

Call:
>>> inp.SetTWall(v, name="wall")
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

v: float | str

Value of wall temperature

name: {"wall"} | str

Name of boundary condition zone

Versions:

  • 2020-04-28 @ddalle: First version

SetTemperature(v, name='inflow')

Set static temperature on inflow boundary condition

Call:
>>> inp.SetTemperature(v, name="inflow")
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

v: float | str

Value of freestream static temperature

name: {"inflow"} | str

Name of boundary condition zone

Versions:

  • 2020-04-28 @ddalle: First version

SetVelocity(v, name='inflow')

Set vibrational temperature on inflow boundary condition

Call:
>>> inp.SetVibTemp(v, name="inflow")
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

v: float | str

Value of freestream vibrational temperature

name: {"inflow"} | str

Name of boundary condition zone

Versions:

  • 2020-04-28 @ddalle: First version

SetVibTemp(v, name='inflow')

Set vibrational temperature on inflow boundary condition

Call:
>>> inp.SetVibTemp(v, name="inflow")
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

v: float | str

Value of freestream vibrational temperature

name: {"inflow"} | str

Name of boundary condition zone

Versions:

  • 2020-04-28 @ddalle: First version

TAILOR_keys = [['igtm', 'igtt', 'sens'], ['ngts', 'ngtp', 'igti']]
get_CFDSOLVEROPTS_key(key)

Get parameter key from CFD_SOLVER_OPTS section

Call:
>>> val = inp.get_CFDSOLVEROPTS_key(key)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

key: str

Name of parameter

Outputs:
val: int | float | None

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_cfl()

Get cfl from CFD_SOLVER section

Call:
>>> cfl = inp.get_CFDSOLVER_cfl()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
cfl: float

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_dtfix()

Get dtfix from CFD_SOLVER section

Call:
>>> dtfix = inp.get_CFDSOLVER_dtfix()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
dtfix: float

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_epsj()

Get epsj from CFD_SOLVER section

Call:
>>> epsj = inp.get_CFDSOLVER_epsj()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
epsj: float

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_ibase()

Get ibase from CFD_SOLVER section

Call:
>>> ibase = inp.get_CFDSOLVER_ibase()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
ibase: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_icfl()

Get icfl from CFD_SOLVER section

Call:
>>> icfl = inp.get_CFDSOLVER_icfl()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
icfl: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_ichem()

Get ichem from CFD_SOLVER section

Call:
>>> ichem = inp.get_CFDSOLVER_ichem()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
ichem: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_iconr()

Get iconr from CFD_SOLVER section

Call:
>>> iconr = inp.get_CFDSOLVER_iconr()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
iconr: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_idiss_g()

Get idiss_g from CFD_SOLVER section

Call:
>>> idiss_g = inp.get_CFDSOLVER_idiss_g()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
idiss_g: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_idmod()

Get idmod from CFD_SOLVER section

Call:
>>> idmod = inp.get_CFDSOLVER_idmod()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
idmod: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_ikmod()

Get ikmod from CFD_SOLVER section

Call:
>>> ikmod = inp.get_CFDSOLVER_ikmod()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
ikmod: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_ikv()

Get ikv from CFD_SOLVER section

Call:
>>> ikv = inp.get_CFDSOLVER_ikv()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
ikv: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_ikve()

Get nplot from CFD_SOLVER section

Call:
>>> ikve = inp.get_CFDSOLVER_ikve()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
ikve: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_iman()

Get iman from CFD_SOLVER section

Call:
>>> iman = inp.get_CFDSOLVER_iman()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
iman: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_impl()

Get impl from CFD_SOLVER section

Call:
>>> impl = inp.get_CFDSOLVER_impl()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
impl: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_iorder()

Get iorder from CFD_SOLVER section

Call:
>>> iorder = inp.get_CFDSOLVER_iorder()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
iorder: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_ires()

Get ires from CFD_SOLVER section

Call:
>>> ires = inp.get_CFDSOLVER_ires()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
ires: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_itrb()

Get itrb from CFD_SOLVER section

Call:
>>> itrb = inp.get_CFDSOLVER_itrb()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
itrb: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_iuem()

Get iuem from CFD_SOLVER section

Call:
>>> iuem = inp.get_CFDSOLVER_iuem()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
iuem: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_ivib()

Get ivib from CFD_SOLVER section

Call:
>>> ivib = inp.get_CFDSOLVER_ivib()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
ivib: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_ivisc()

Get ivisc from CFD_SOLVER section

Call:
>>> ivisc = inp.get_CFDSOLVER_ivisc()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
ivisc: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_ivmod()

Get ivmod from CFD_SOLVER section

Call:
>>> ivmod = inp.get_CFDSOLVER_ivmod()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
ivmod: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_kbl()

Get kbl from CFD_SOLVER section

Call:
>>> kbl = inp.get_CFDSOLVER_kbl()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
kbl: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_key(key)

Get value of parameter key from CFD_SOLVER section

Call:
>>> val = inp.get_CFDSOLVER_key(key)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

key: str

Name of parameter

Outputs:
val: int | float | None

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_kmax()

Get kmax from CFD_SOLVER section

Call:
>>> kmax = inp.get_CFDSOLVER_kmax()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
kmax: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_kmaxo()

Get kmaxo from CFD_SOLVER section

Call:
>>> kmaxo = inp.get_CFDSOLVER_kmaxo()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
kmaxo: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_npfac()

Get npfac from CFD_SOLVER section

Call:
>>> npfac = inp.get_CFDSOLVER_npfac()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
npfac: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_nplot()

Get nplot from CFD_SOLVER section

Call:
>>> nplot = inp.get_CFDSOLVER_nplot()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
nplot: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_npvol()

Get npvol from CFD_SOLVER section

Call:
>>> npvol = inp.get_CFDSOLVER_npvol()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
npvol: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_nstop()

Get nstop from CFD_SOLVER section

Call:
>>> nstop = inp.get_CFDSOLVER_nstop()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
nstop: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_CFDSOLVER_wdis()

Get wdis from CFD_SOLVER section

Call:
>>> wdis = inp.get_CFDSOLVER_wdis()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
wdis: float

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_MANAGE_flag()

Get flag from MANAGE section, first table entry

Call:
>>> flag = inp.get_MANAGE_table()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
flag: int >= 0

Flag for what action for US3D to take

Versions:

  • 2019-06-19 @ddalle: First version

get_MANAGE_schedule()

Get CFL schedule from MANAGE section

Call:
>>> table = inp.get_MANAGE_schedule()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
table: list

List of values in each row

Versions:

  • 2019-06-19 @ddalle: First version

get_MANAGE_table()

Get entire table of MANAGE CFL schedule

Call:
>>> table = inp.get_MANAGE_table()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
table: list

List of values in each row

Versions:

  • 2019-06-19 @ddalle: First version

get_TAILOR_igti()

Get igti from TAILOR section

Call:
>>> igti = inp.get_TAILOR_igti()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
igti: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_TAILOR_igtm()

Get igtm from TAILOR section

Call:
>>> igtm = inp.get_TAILOR_igtm()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
igtm: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_TAILOR_igtt()

Get igtt from TAILOR section

Call:
>>> igtt = inp.get_TAILOR_igtt()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
igtt: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_TAILOR_key(key)

Get value of parameter key from TAILOR section

Call:
>>> val = inp.get_TAILOR_key(key)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

key: str

Name of parameter

Outputs:
val: int | float | None

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_TAILOR_ngtp()

Get ngtp from TAILOR section

Call:
>>> ngtp = inp.get_TAILOR_ngtp()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
ngtp: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_TAILOR_ngts()

Get ngts from TAILOR section

Call:
>>> ngts = inp.get_TAILOR_sens()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
ngts: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

get_TAILOR_sens()

Get sens from TAILOR section

Call:
>>> sens = inp.get_TAILOR_sens()
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

Outputs:
sens: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVEROPTS_key(key, val)

Get parameter key from CFD_SOLVER_OPTS section

Call:
>>> val = inp.get_CFDSOLVEROPTS_key(key)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

key: str

Name of parameter

val: int | float | None

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_cfl(cfl)

Set cfl in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_cfl(cfl)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

cfl: float

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_dtfix(dtfix)

Set dtfix in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_dtfix(dtfix)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

dtfix: float

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_epsj(epsj)

Set epsj in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_epsj(epsj)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

epsj: float

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_ibase(ibase)

Set ibase in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_ibase(ibase)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

ibase: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_icfl(icfl)

Set icfl in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_icfl(icfl)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

icfl: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_ichem(ichem)

Set ichem in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_ichem(ichem)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

ichem: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_iconr(iconr)

Set nplot in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_iconr(iconr)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

iconr: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_idiss_g(idiss_g)

Set idiss_g in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_idiss_g(idiss_g)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

idiss_g: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_idmod(idmod)

Set idmod in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_idmod(idmod)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

idmod: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_ikmod(ikmod)

Set ikmod in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_(ikmod)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

ikmod: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_ikv(ikv)

Set ikv in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_ikv(ikv)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

ikv: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_ikve(ikve)

Set ikve in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_ikve(ikve)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

ikve: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_iman(iman)

Set iman in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_iman(iman)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

iman: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_impl(impl)

Set impl in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_impl(impl)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

impl: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_iorder(iorder)

Set iorder in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_iorder(iorder)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

iorder: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_ires(ires)

Set ires in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_nstop(nstop)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

ires: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_itrb(itrb)

Set itrb in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_itrb(itrb)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

itrb: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_iuem(iuem)

Set iuem in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_iuem(iuem)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

iuem: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_ivib(ivib)

Set ivib in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_ivib(ivib)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

ivib: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_ivisc(ivisc)

Set ivisc in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_(ivisc)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

ivisc: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_ivmod(ivmod)

Set ivmod in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_ivmod(ivmod)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

ivmod: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_kbl(kbl)

Set kbl in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_kbl(kbl)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

kbl: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_key(key, val)

Get value of parameter key from CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_key(key, val)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

key: str

Name of parameter

val: int | float | None

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_kmax(nplot)

Set kmax in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_kmax(kmax)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

kmax: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_kmaxo(ires)

Set kmaxo in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_kmaxo(kmaxo)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

kmaxo: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_npfac(npfac)

Set npfac in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_npfac(npfac)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

npfac: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_nplot(nplot)

Set nplot in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_nstop(nstop)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

nplot: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_npvol(npvol)

Set npvol in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_npvol(npvol)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

npvol: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_nstop(nstop)

Set nstop in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_nstop(nstop)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

nstop: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_CFDSOLVER_wdis(wdis)

Set wdis in CFD_SOLVER section

Call:
>>> inp.set_CFDSOLVER_wdis(wdis)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

wdis: float

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_MANAGE_table(table)

Set entire table of MANAGE CFL schedule

Call:
>>> inp.set_MANAGE_table(table)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

table: list

List of values in each row

Versions:

  • 2019-06-19 @ddalle: First version

set_TAILOR_igti(igti)

Set igti in TAILOR section

Call:
>>> inp.set_TAILOR_igti(igti)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

igti: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_TAILOR_igtm(igtm)

Set igtm in TAILOR section

Call:
>>> inp.set_TAILOR_igtm(igtm)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

igtm: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_TAILOR_igtt(igtt)

Set igtm in TAILOR section

Call:
>>> inp.set_TAILOR_igtm(igtm)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

igtt: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_TAILOR_key(key, val)

Get value of parameter key from TAILOR section

Call:
>>> inp.set_TAILOR_key(key, val)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

key: str

Name of parameter

val: int | float | None

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_TAILOR_ngtp(ngtp)

Set ngtp in TAILOR section

Call:
>>> inp.set_TAILOR_ngtp(ngtp)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

ngtp: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_TAILOR_ngts(ngts)

Set ngts in TAILOR section

Call:
>>> inp.set_TAILOR_ngts(ngts)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

ngts: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version

set_TAILOR_sens(sens)

Set sens in TAILOR section

Call:
>>> inp.set_TAILOR_sens(sens)
Inputs:
inp: cape.pyus.inputinpfile.InputInp

Namelist file control instance

sens: int

Value in input.inp file

Versions:

  • 2019-06-06 @ddalle: First version