cape.pyover.options.DataBook: Data book options

This module contains the interface for data book options for pyOver and OVERFLOW. The classes in this module are subclassed as

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.DataBook.DBTarget

Dictionary-based interface for databook targets

class cape.pyover.options.DataBook.DataBook(fname=None, **kw)

Dictionary-based interface for DataBook specifications

Call:
>>> opts = DataBook(**kw)
Outputs:

opts: pyOver.options.dataBook.DataBook

Versions:

  • 2015-12-29 @ddalle: Subclassed from CAPE

get_DataBook_QIn(comp)

Get the input q file for a databook component

Call:
>>> fq = opts.get_DataBook_QIn(comp)
Inputs:
opts: pyOver.options.Options

Options interface

comp: str

Name of line load data book component

Outputs:
fq: {"q.pyover.p3d"} | str

Name of input Overflow solution file

Versions:

  • 2017-01-10 @ddalle: First version

get_DataBook_QOut(comp)

Get the preprocessed q file for a databook component

Call:
>>> fq = opts.get_DataBook_QOut(comp)
Inputs:
opts: pyOver.options.Options

Options interface

comp: str

Name of line load data book component

Outputs:
fq: {None} | "q.pyover.srf" | str

Name of output Overflow solution file

Versions:

  • 2017-01-10 @ddalle: First version

get_DataBook_QSurf(comp)

Get the preprocessed q.srf file name for a databook component

Call:
>>> fq = opts.get_DataBook_QSurf(comp)
Inputs:
opts: pyOver.options.Options

Options interface

comp: str

Name of line load data book component

Outputs:
fq: None | {"q.pyover.srf"} | str

Name of output Overflow surface solution file

Versions:

  • 2017-01-10 @ddalle: First version

get_DataBook_XIn(comp)

Get the input x file for a databook component

Call:
>>> fx = opts.get_DataBook_XIn(comp)
Inputs:
opts: pyOver.options.Options

Options interface

comp: str

Name of line load data book component

Outputs:
fx: {"x.pyover.p3d"} | str

Name of input Overflow grid file

Versions:

  • 2017-01-10 @ddalle: First version

get_DataBook_XOut(comp)

Get the input x file for a databook component

Call:
>>> fx = opts.get_DataBook_XOut(comp)
Inputs:
opts: pyOver.options.Options

Options interface

comp: str

Name of line load data book component

Outputs:
fx: {None} | "x.pyover.srf" | str

Name of output Overflow grid file

Versions:

  • 2017-01-10 @ddalle: First version

get_DataBook_XSurf(comp)

Get the input x.srf file for a databook component

Call:
>>> fx = opts.get_DataBook_XSurf(comp)
Inputs:
opts: pyOver.options.Options

Options interface

comp: str

Name of line load data book component

Outputs:
fx: None | {"x.pyover.srf"} | str

Name of output Overflow grid file

Versions:

  • 2017-01-10 @ddalle: First version

get_DataBook_fomo(comp)

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:
>>> fdir = opts.get_DataBook_fomo(comp)
Inputs:
opts: pyOver.options.Options

Options interface

comp: str

Name of line load data book component

Outputs:
fdir: {None} | str

Path to mixsur output files

Versions:

  • 2017-01-11 @ddalle: First version

get_DataBook_mixsur(comp)

Get the mixsur or overint input file for a databook component

Call:
>>> fname = opts.get_DataBook_mixsur(comp)
Inputs:
opts: pyOver.options.Options

Options interface

comp: str

Name of line load data book component

Outputs:
fname: str

Name of mixsur input file template

Versions:

  • 2016-12-29 @ddalle: First version

get_DataBook_splitmq(comp)

Get the splitmq input file for a databook component

Call:
>>> fname = opts.get_DataBook_splitmq(comp)
Inputs:
opts: pyOver.options.Options

Options interface

comp: str

Name of line load data book component

Outputs:
fname: str

Name of splitmq input file template

Versions:

  • 2016-12-29 @ddalle: First version

get_DataBook_usurp(comp)

Get the mixsur input file for use with usurp

Call:
>>> fname = opts.get_DataBook_usurp(comp)
Inputs:
opts: pyOver.options.Options

Options interface

comp: str

Name of line load data book component

Outputs:
fname: str

Name of mixsur input file template

Versions:

  • 2017-04-06 @ddalle: First version