This module contains the interface for DataBook options that are
specific to OVERFLOW and cape.pyover.
The OVERFLOW-specific options for these classes are limited, but a few
methods are modified in order to change default data book component
types and the columns of data available for each. In particular, may
special options for usurp or mixsur are specified, which is
needed to extract a surface triangulation from an OVERFLOW solution.
-
class cape.pyover.options.databookopts.DataBookOpts(*args, **kw)
-
get_DataBook_QIn(comp=None, j=None, i=None, **kw)
Get input q file
- Call:
>>> QIn = opts.get_DataBook_QIn(comp=None, i=None, **kw)
- Inputs:
- opts: DataBookOpts
options interface
- comp: {
None} | str Name of databook component
- i: {
None} | int Case index
- Outputs:
- QIn: {
None} | str input q file
-
get_DataBook_QOut(comp=None, j=None, i=None, **kw)
Get preprocessed q file for a databook component
- Call:
>>> QOut = opts.get_DataBook_QOut(comp=None, i=None, **kw)
- Inputs:
- opts: DataBookOpts
options interface
- comp: {
None} | str Name of databook component
- i: {
None} | int Case index
- Outputs:
- QOut: {
None} | str preprocessed q file for a databook component
-
get_DataBook_QSurf(comp=None, j=None, i=None, **kw)
Get preprocessed q.srf file name
- Call:
>>> QSurf = opts.get_DataBook_QSurf(comp=None, i=None, **kw)
- Inputs:
- opts: DataBookOpts
options interface
- comp: {
None} | str Name of databook component
- i: {
None} | int Case index
- Outputs:
- QSurf: {
None} | str preprocessed q.srf file name
-
get_DataBook_XIn(comp=None, j=None, i=None, **kw)
Get input x file
- Call:
>>> XIn = opts.get_DataBook_XIn(comp=None, i=None, **kw)
- Inputs:
- opts: DataBookOpts
options interface
- comp: {
None} | str Name of databook component
- i: {
None} | int Case index
- Outputs:
- XIn: {
None} | str input x file
-
get_DataBook_XOut(comp=None, j=None, i=None, **kw)
Get preprocessed x file for a databook component
- Call:
>>> XOut = opts.get_DataBook_XOut(comp=None, i=None, **kw)
- Inputs:
- opts: DataBookOpts
options interface
- comp: {
None} | str Name of databook component
- i: {
None} | int Case index
- Outputs:
- XOut: {
None} | str preprocessed x file for a databook component
-
get_DataBook_XSurf(comp=None, j=None, i=None, **kw)
Get preprocessed x.srf file name
- Call:
>>> XSurf = opts.get_DataBook_XSurf(comp=None, i=None, **kw)
- Inputs:
- opts: DataBookOpts
options interface
- comp: {
None} | str Name of databook component
- i: {
None} | int Case index
- Outputs:
- XSurf: {
None} | str preprocessed x.srf file name
-
get_DataBook_fomo(comp=None, j=None, i=None, **kw)
Get path to mixsur output files
If each of the following files is found, there is no need to run
mixsur, and files are linked instead.
grid.i.tri
grid.bnd
grid.ib
grid.ibi
grid.map
grid.nsf
grid.ptv
mixsur.fmp
- Call:
>>> fomo = opts.get_DataBook_fomo(comp=None, i=None, **kw)
- Inputs:
- opts: DataBookOpts
options interface
- comp: {
None} | str Name of databook component
- i: {
None} | int Case index
- Outputs:
- fomo: {
None} | str path to mixsur output files
If each of the following files is found, there is no need to run
mixsur, and files are linked instead.
grid.i.tri
grid.bnd
grid.ib
grid.ibi
grid.map
grid.nsf
grid.ptv
mixsur.fmp
-
get_DataBook_mixsur(comp=None, j=None, i=None, **kw)
Get input file for mixsur, overint, or usurp
- Call:
>>> mixsur = opts.get_DataBook_mixsur(comp=None, i=None, **kw)
- Inputs:
- opts: DataBookOpts
options interface
- comp: {
None} | str Name of databook component
- i: {
None} | int Case index
- Outputs:
- mixsur: {
None} | str input file for mixsur, overint, or usurp
-
get_DataBook_splitmq(comp=None, j=None, i=None, **kw)
Get input file for splitmq
- Call:
>>> splitmq = opts.get_DataBook_splitmq(comp=None, i=None, **kw)
- Inputs:
- opts: DataBookOpts
options interface
- comp: {
None} | str Name of databook component
- i: {
None} | int Case index
- Outputs:
- splitmq: {
None} | str input file for splitmq
-
get_DataBook_usurp(comp=None, j=None, i=None, **kw)
Get input file for usurp
- Call:
>>> usurp = opts.get_DataBook_usurp(comp=None, i=None, **kw)
- Inputs:
- opts: DataBookOpts
options interface
- comp: {
None} | str Name of databook component
- i: {
None} | int Case index
- Outputs:
- usurp: {
None} | str input file for usurp
