cape.pyus.cmdrun: US3D binary interface module

This module provides an interface to the various US3D executables and other command-line utilities from cape.bin. However, due to some of the subtleties of how the main US3D executables are called, cape.pyus.casecntl.RunPhase() constructs the commands to run US3D from cape.pyus.cmdgen locally and runs them using cape.cmdrun.callf().

See also:
cape.pyus.cmdrun.us3d(opts, i=0, **kw)

Interface to US3D executable us3d

Call:
>>> ierr = cmdrun.us3d(opts, i=0)
>>> ierr = cmdrun.us3d(**kw)
Inputs:
opts: cape.pyus.options.Options

Global or “RunControl” pyUS options

i: int

Phase number

input: {"input.inp"} | str

Name of US3D input file

grid: {"grid.h5"} | str

Name of input HDF5 mesh

gas: {None} | str

Name of gas file to use

Outputs:
ierr: int

Exit status

Versions:

  • 2020-04-29 @ddalle: First version

cape.pyus.cmdrun.us3d_genbc(opts, i=0, **kw)

Run US3D executable us3d-genbc

Call:
>>> ierr = cmdrun.us3d_genbc(opts, i=0)
>>> ierr = cmdrun.us3d_genbc(**kw)
Inputs:
opts: cape.pyus.options.Options

Global or “RunControl” pyUS options

i: int

Phase number

grid: {"grid.h5"} | str

Name of prepared US3D grid

Outputs:
ierr: int

Exit status

Versions:

  • 20120-04-27 @ddalle: First version

cape.pyus.cmdrun.us3d_prepar(opts, i=0, **kw)

Run US3D executable us3d-prepar

Call:
>>> ierr = cmdrun.us3d_prepar(opts, i=0)
>>> ierr = cmdrun.us3d_prepar(**kw)
Inputs:
opts: cape.pyus.options.Options

Global or “RunControl” pyUS options

i: int

Phase number

grid: {"pyus.case"} | str

Name of input Fluent mesh

output: {None} | str

Name of output HDF5 grid ("grid.h5")

conn: {None} | str

Name of output connectivity file ("conn.h5")

Outputs:
ierr: int

Exit status

Versions:

  • 2020-04-20 @ddalle: First version