cape.pylava.report: Automated report interface

This customization of the cape.cfdx.report class for LAVA mostly just points to the correct databook classes that are specific to LAVA.

class cape.pylava.report.Report(cntl, rep)

Interface for automated report generation

Call:

>>> R = Report(cntl, rep)

Inputs:

cntl: cape.pykes.cntl.Cntl

CAPE main control instance

rep: str

Name of report to update

Outputs:

R: pyFun.report.Report

Automated report interface

Versions:

• 2021-12-01 @ddalle: Version 1.0

ReadCaseFM(comp: str)

Read iterative history for a component

This function needs to be customized for each solver

Call:

>>> fm = r.ReadCaseFM(comp)

Inputs:

r: cape.cfdx.report.Report

Automated report interface

comp: str

Name of component to read

Outputs:

fm: None | CaseFM

Case iterative force & moment history for one component

Versions:

• 2024-10-11 @ddalle: v1.0

ReadCaseResid(sfig: str | None = None)

Read iterative residual history for a component

This function needs to be customized for each solver

Call:

>>> hist = R.ReadCaseResid(sfig=None)

Inputs:

R: cape.cfdx.report.Report

Automated report interface

sfig: str | None

Name of subfigure to process

Outputs:

hist: None or cape.cfdx.databook.CaseResid

derivative Case iterative residual history for one case

Versions:

• 2024-10-11 @ddalle: v1.0

SubfigSwitch(sfig, i, lines, q)

Switch function to find the correct subfigure function

This function may need to be defined for each CFD solver

Call:

>>> lines = R.SubfigSwitch(sfig, i, lines)

Inputs:

R: pyFun.report.Report

Automated report interface

sfig: str

Name of subfigure to update

i: int

Case index

lines: list[str]

List of lines already in LaTeX file

q: True | False

Whether or not to regenerate subfigure

Outputs:

lines: list[str]

Updated list of lines for LaTeX file

Versions:

• 2015-05-29 @ddalle: Version 1.0

• 2016-10-25 @ddalle: UpdateCaseSubfigs ->

  SubfigSwitch