cape.cfdx.databookbase: Abstract base classes for DataBook

This module provides abstract base classes for the “DataBook” capability in CAPE, which collects post-processed data from CFD cases.

The main class is DataBookBase, which is the base class for cape.cfdx.databook.DataBook.

See also:

• cape.cfdx.databook

class cape.cfdx.databookbase.DataBookBase(cntl, RootDir: str | None = None, targ: str | None = None, **kw)

Bases: dict

Interface to the data book for a given CFD run matrix

Call:

>>> DB = DataBook(cntl, **kw)

Inputs:

cntl: Cntl

CAPE control class instance

RootDir: str

Root directory, defaults to os.getcwd()

targ: {None} | str

Option to read duplicate data book as a target named targ

Outputs:

DB: cape.cfdx.databook.DataBook

Instance of the Cape data book class

DB.x: cape.runmatrix.RunMatrix

Run matrix of rows saved in the data book

DB[comp]: cape.cfdx.databook.DBComp

Component data book for component comp

DB.Components: list[str]

List of force/moment components

DB.Targets: dict

Dictionary of TargetDataBook target data books