3.1.4.2. Options for FM
component¶
Option aliases:
Coeffs -> Cols
Coefficients -> Cols
Component -> CompID
NAvg -> nStats
NFirst -> NMin
NLast -> nLastStats
NMax -> nLastStats
coeffs -> Cols
cols -> Cols
dnStats -> DNStats
nAvg -> NStats
nFirst -> NMin
nLast -> NLastStats
nLastStats -> NLastStats
nMax -> NLastStats
nMaxStats -> NMaxStats
nMin -> NMin
nStats -> NStats
tagets -> Targets
Recognized options:
- Cols: {
'CA'
} |str
list of primary solver output variables to include
- CompID: {
None
} |object
surface componet(s) to use for this databook component
- DNStats: {
None
} |int
increment for candidate window sizes
- FloatCols: {
[]
} |str
additional databook cols with floating-point values
- IntCols: {
'nIter'
} |str
additional databook cols with integer values
- NLastStats: {
None
} |int
specific iteration at which to extract stats
- NMaxStats: {
None
} |int
max number of iters to include in averaging window
- NMin: {
None
} |int
first iter to consider for use in databook [for a comp]
- NStats: {
None
} |int
iterations to use in averaging window [for a comp]
- Targets: {
{}
} |dict
targets for this databook component
- Transformations: {
[]
} |dict
list of transformations applied to component
- Type: {
'FM'
} |str
databook component type