5.2.4. Options for DataBook Section¶
The options below are the available options in the DataBook Section of the pyfun.json control file
- Folder: {
'data'} |str folder for root of databook
- NMaxStats: {
None} |int|int32|int64 max number of iters to include in averaging window
- Type: {
'FM'} |'PyFunc'|'TriqFM'|'TriqPoint'|'IterPoint'|'LineLoad' Default component type
- Components: {
None} |str list of databook components
- Delimiter: {
','} |str delimiter to use in databook files
- NLastStats: {
None} |int|int32|int64 specific iteration at which to extract stats
- DNStats: {
None} |int|int32|int64 increment for candidate window sizes
- NMin: {
0} |int|int32|int64 first iter to consider for use in databook [for a comp]
- NStats: {
0} |int|int32|int64 iterations to use in averaging window [for a comp]
- Targets: {
None} |object value of option “Targets”
5.2.4.1. Options for all Targets¶
- Folder: {
'data'} |str Name of folder from which to read data
- Translations: {
None} |dict value of option “Translations”
- Type: {
'generic'} |'databook' DataBook Target type
- Label: {
None} |str Label to use when plotting this target
- Delimiter: {
','} |str Delimiter in databook target data file
- Components: {
None} |list[str] List of databook components with data from this target
- Tolerances: {
None} |dict Dictionary of tolerances for run matrix keys
- CommentChar: {
'#'} |str value of option “CommentChar”
- Name: {
None} |str Internal name to use for target
- File: {
None} |str Name of file from which to read data
5.2.4.2. FM Options¶
- FloatCols: {
['nOrders']} |str additional databook cols with floating-point values
- Transformations: {
[]} |dict list of transformations applied to component
- NMaxStats: {
None} |int|int32|int64 max number of iters to include in averaging window
- CompID: {
None} |object surface componet(s) to use for this databook component
- Type: {
'FM'} |str databook component type
- NLastStats: {
None} |int|int32|int64 specific iteration at which to extract stats
- DNStats: {
None} |int|int32|int64 increment for candidate window sizes
- IntCols: {
['nIter', 'nStats']} |str additional databook cols with integer values
- NMin: {
None} |int|int32|int64 first iter to consider for use in databook [for a comp]
- NStats: {
None} |int|int32|int64 iterations to use in averaging window [for a comp]
- Cols: {
['CA', 'CY', 'CN', 'CLL', 'CLM', 'CLN']} |str list of primary solver output variables to include
- Targets: {
{}} |dict targets for this databook component
5.2.4.3. IterPoint Options¶
- FloatCols: {
[]} |str additional databook cols with floating-point values
- Transformations: {
[]} |dict list of transformations applied to component
- NMaxStats: {
None} |int|int32|int64 max number of iters to include in averaging window
- CompID: {
None} |object surface componet(s) to use for this databook component
- Type: {
'FM'} |str databook component type
- NLastStats: {
None} |int|int32|int64 specific iteration at which to extract stats
- DNStats: {
None} |int|int32|int64 increment for candidate window sizes
- IntCols: {
['nIter', 'nStats']} |str additional databook cols with integer values
- NMin: {
None} |int|int32|int64 first iter to consider for use in databook [for a comp]
- NStats: {
None} |int|int32|int64 iterations to use in averaging window [for a comp]
- Targets: {
{}} |dict targets for this databook component
- Cols: {
['cp']} |str list of primary solver output variables to include
- Points: {
None} |list[str] list of individual point sensors
5.2.4.4. LineLoad Options¶
- FloatCols: {
[]} |str additional databook cols with floating-point values
- Gauge: {
True} |bool|bool_ option to use gauge pressures in computations
- SectionType: {
'dlds'} |'clds'|'slds' line load section type
- Type: {
'FM'} |str databook component type
- NLastStats: {
None} |int|int32|int64 specific iteration at which to extract stats
- DNStats: {
None} |int|int32|int64 increment for candidate window sizes
- Trim: {
1} |int|int32|int64 trim flag to
triload- IntCols: {
['nIter', 'nStats']} |str additional databook cols with integer values
- NMin: {
None} |int|int32|int64 first iter to consider for use in databook [for a comp]
- NCut: {
200} |int|int32|int64 number of cuts to make using
triload(-> +1 slice)- Cols: {
[]} |str list of primary solver output variables to include
- Targets: {
{}} |dict targets for this databook component
- Transformations: {
[]} |dict list of transformations applied to component
- NMaxStats: {
None} |int|int32|int64 max number of iters to include in averaging window
- CompID: {
None} |object surface componet(s) to use for this databook component
- Momentum: {
False} |bool|bool_ whether to use momentum flux in line load computations
- NStats: {
None} |int|int32|int64 iterations to use in averaging window [for a comp]
5.2.4.5. PyFunc Options¶
- FloatCols: {
[]} |str additional databook cols with floating-point values
- Transformations: {
[]} |dict list of transformations applied to component
- NMaxStats: {
None} |int|int32|int64 max number of iters to include in averaging window
- CompID: {
None} |object surface componet(s) to use for this databook component
- Type: {
'FM'} |str databook component type
- NLastStats: {
None} |int|int32|int64 specific iteration at which to extract stats
- DNStats: {
None} |int|int32|int64 increment for candidate window sizes
- IntCols: {
['nIter', 'nStats']} |str additional databook cols with integer values
- Function: {
None} |str Python function name
- NMin: {
None} |int|int32|int64 first iter to consider for use in databook [for a comp]
- NStats: {
None} |int|int32|int64 iterations to use in averaging window [for a comp]
- Targets: {
{}} |dict targets for this databook component
- Cols: {
[]} |str list of primary solver output variables to include
5.2.4.6. TriqFM Options¶
- ConfigFile: {
None} |str configuration file for surface groups
- FloatCols: {
[]} |str additional databook cols with floating-point values
- Type: {
'FM'} |str databook component type
- NLastStats: {
None} |int|int32|int64 specific iteration at which to extract stats
- CompTol: {
None} |float|float32 tangent tolerance relative to component
- DNStats: {
None} |int|int32|int64 increment for candidate window sizes
- IntCols: {
['nIter']} |str additional databook cols with integer values
- NMin: {
None} |int|int32|int64 first iter to consider for use in databook [for a comp]
- AbsProjTol: {
None} |float|float32 absolute projection tolerance
- MapTri: {
None} |str name of a tri file to use for remapping CFD surface comps
- Cols: {
['CA', 'CY', 'CN', 'CAv', 'CYv', 'CNv', 'Cp_min', 'Cp_max', 'Ax', 'Ay', 'Az']} |str list of primary solver output variables to include
- Targets: {
{}} |dict targets for this databook component
- AbsTol: {
None} |float|float32 absolute tangent tolerance for surface mapping
- Transformations: {
[]} |dict list of transformations applied to component
- NMaxStats: {
None} |int|int32|int64 max number of iters to include in averaging window
- CompID: {
None} |object surface componet(s) to use for this databook component
- CompProjTol: {
None} |float|float32 projection tolerance relative to size of component
- OutputFormat: {
'plt'} |'dat' output format for component surface files
- NStats: {
None} |int|int32|int64 iterations to use in averaging window [for a comp]
- Patches: {
None} |list[str] list of patches for a databook component
- RelProjTol: {
None} |float|float32 projection tolerance relative to size of geometry
- RelTol: {
None} |float|float32 relative tangent tolerance for surface mapping
5.2.4.7. TriqPoint Options¶
- FloatCols: {
[]} |str additional databook cols with floating-point values
- Transformations: {
[]} |dict list of transformations applied to component
- NMaxStats: {
None} |int|int32|int64 max number of iters to include in averaging window
- CompID: {
None} |object surface componet(s) to use for this databook component
- Type: {
'FM'} |str databook component type
- NLastStats: {
None} |int|int32|int64 specific iteration at which to extract stats
- DNStats: {
None} |int|int32|int64 increment for candidate window sizes
- IntCols: {
['nIter']} |str additional databook cols with integer values
- NMin: {
None} |int|int32|int64 first iter to consider for use in databook [for a comp]
- NStats: {
None} |int|int32|int64 iterations to use in averaging window [for a comp]
- Targets: {
{}} |dict targets for this databook component
- Cols: {
['x', 'y', 'z', 'cp']} |str list of primary solver output variables to include
- Points: {
None} |list[str] list of individual point sensors
