cape.pylava.databook: LAVA data book module

This module provides LAVA-specific interfaces to the various CFD outputs tracked by the cape package.

class cape.pylava.databook.CaseFM(comp: str, **kw)

Iterative LAVA component force & moment history

Call:

>>> fm = CaseFMCartesian(comp=None)

Inputs:

comp: str

Name of component

Outputs:

fm: CaseFM

One-case iterative history

Versions:

• 2024-09-30 @sneuhoff: v1.0;

get_filelist() → list

Get list of files to read

Call:

>>> filelist = fm.get_filelist()

Inputs:

prop: CaseFM

Component iterative history instance

Outputs:

filelist: list[str]

List of files to read to construct iterative history

Versions:

• 2024-09-18 @sneuhoff: v1.0

• 2025-07-17 @ddalle: v1.1; merge Curv & Cart

readfile(fname: str) → dict

Read the data.iter

Call:

>>> db = fm.readfile(fname)

Inputs:

fm: CaseFM

Single-component iterative history instance

fname: str

Name of file to read

Outputs:

db: dict

Data read from data.iter

Versions:

• 2024-09-18 @sneuhoff: v1.0

• 2024-10-11 @ddalle: v1.1; use DataIterFile

class cape.pylava.databook.CasePointProbe(pt: str, runner=None, **kw)

get_filelist() → list

Get list of files to read

Call:

>>> filelist = probe.get_filelist()

Inputs:

prop: CaseFM

Component iterative history instance

Outputs:

filelist: list[str]

List of files to read to construct iterative history

Versions:

• 2026-03-11 @ddalle: v1.0

readfile(fname: str) → dict

Read the point probe

Call:

>>> db = probe.readfile(fname)

Inputs:

probe: CasePointProbe

Single-component iterative history instance

fname: str

Name of file to read

Outputs:

db: BaseData

Data read from fname

Versions:

• 2024-09-30 @sneuhoff: v1.0

• 2024-10-11 @ddalle: v1.1; use DataiterFile

class cape.pylava.databook.CaseResid(comp: str = 'body1', meta=False, runner=False, **kw)

Iterative residual history for one component, one case

Call:

>>> hist = CaseResid(comp=None)

Inputs:

comp: {None} | str

Name of component

Outputs:

hist: CaseResid

One-case iterative history

Versions:

• 2024-09-30 @sneuhoff: v1.0;

get_filelist() → list

Get list of files to read

Call:

>>> filelist = fm.get_filelist()

Inputs:

prop: CaseFM

Component iterative history instance

Outputs:

filelist: list[str]

List of files to read to construct iterative history

Versions:

• 2024-09-24 @sneuhoff: v1.0

readfile(fname: str) → dict

Read the data.iter for residuals

Call:

>>> db = fm.readfile(fname)

Inputs:

fm: CaseFM

Single-component iterative history instance

fname: str

Name of file to read

Outputs:

db: BaseData

Data read from fname

Versions:

• 2024-09-30 @sneuhoff: v1.0

• 2024-10-11 @ddalle: v1.1; use DataiterFile