ICalculationToolParameterSet#

class ansys.stk.core.analysis_workbench.ICalculationToolParameterSet#

Parameter set contains various sets of scalar computations.

Overview#

calculate

Return results of computing individual scalars within parameter set at the specified time.

calculate_with_derivative

Return results of computing individual scalars and their time derivatives within parameter set at the specified time.

type

Get the type of parameter set.

labels

Get the labels identifying hierarchy of representations within parameter set.

dimensions

Get the names identifying types of dimensions of individual scalars within parameter set.

scalar_names

Get the names identifying individual scalars within parameter set.

Import detail#

from ansys.stk.core.analysis_workbench import ICalculationToolParameterSet

Property detail#

property ICalculationToolParameterSet.type: ParameterSetType#

Get the type of parameter set.

property ICalculationToolParameterSet.labels: list#

Get the labels identifying hierarchy of representations within parameter set.

property ICalculationToolParameterSet.dimensions: list#

Get the names identifying types of dimensions of individual scalars within parameter set.

property ICalculationToolParameterSet.scalar_names: list#

Get the names identifying individual scalars within parameter set.

Method detail#

ICalculationToolParameterSet.calculate(self, epoch: Any) list#

Return results of computing individual scalars within parameter set at the specified time.

Parameters:

epoch : Any

Returns:

list

ICalculationToolParameterSet.calculate_with_derivative(self, epoch: Any) list#

Return results of computing individual scalars and their time derivatives within parameter set at the specified time.

Parameters:

epoch : Any

Returns:

list