KPIData

Definition of KPI data.

Fields

field_name: FieldName, default = Undefined

Name of a field variable

field_name, filter_name, function_trace or expression_trace is required.
group_name: String, default = ""

Name of a single mesh object that the KPI applies to.

Can be a point, edge, surface or volume.

ForceReaction requires a surface.

StrainEnergyIntegral and TotalKineticEnergy requires a volume.

If neither group_name nor group_names is specified the KPI is computed from the entire domain.
group_names: Vector of String, default = []

A list of mesh objects that the KPI applies to.

Can be a mixed set of points, edges, surfaces and/or volumes.

ForceReaction requires a surface set.

StrainEnergyIntegral and TotalKineticEnergy requires a volume set.

If neither group_name nor group_names is specified the KPI is computed from the entire domain.
filter_name: FilterName, default = Undefined

Name of a filter to apply to a region of the model.

field_name or filter_name is required.
filter_options_type: FilterOptionsType, default = NONE
filter_options: FilterOptionsType, default = NONE

Additional information that might be needed to compute the KPI
kpi_name: String, default = ""

Name of a kpi variable (optional)
function_trace: FunctionTrace, default = {}

Request the trace of a 1D function. In order to specify the x axis range for the function trace,

one uses the FunctionTrace.min and FunctionTrace.max option. These options should be left empty if

one wants to get the trace as a function of time for a transient simulation. The kpi_name for

the function trace is given as "Y_"+FunctionTrace.function_name. For the case where the x axis

is not time, an additional KPI with kpi_name "X_"+FunctionTrace.function_name is written out.
expression_trace: ExpressionTrace, default = {}

Request the trace of a time expression.