CalculationToolScalarCommonTasks#

class ansys.stk.core.analysis_workbench.CalculationToolScalarCommonTasks#

Common tasks for Calc Scalars.

Overview#

quick_evaluate_array_for_calculation_scalar_array

Each calc scalar in calcArrayVec is evaluated over the array of input times returning the results as an array of elements for each time, each element being an array of results for each calc scalar, results being an array…

quick_evaluate_event_array_for_calculation_scalar_array

Each calc scalar in calcArrayVec is evaluated over the array of times provided by refArray returning results as an array of elements for each time, each element being an array of results for each calc scalar, results being an array…

quick_evaluate_for_calculation_scalar_array

Each calc scalar in calcArrayVec is evaluated at epoch returning results as an array of elements, where each element is itself an array with two elements: 1. success (boolean) 2. value (double-precision).

quick_evaluate_with_rate_array_for_calculation_scalar_array

Each calc scalar in calcArrayVec is evaluated over the array of input times returning the results as an array of elements for each time, each element being an array of results for each calc scalar, results being an array…

quick_evaluate_with_rate_event_array_for_calculation_scalar_array

Each calc scalar in calcArrayVec is evaluated over the array of times provided by refArray returning results as an array of elements for each time, each element being an array of results for each calc scalar, results being an array…

quick_evaluate_with_rate_for_calculation_scalar_array

Each calc scalar in calcArrayVec is evaluated at epoch returning results as an array of elements, where each element is itself an array with three elements: 1. success (boolean) 2. value (double-precision) 3. value rate (double-precision).

Import detail#

from ansys.stk.core.analysis_workbench import CalculationToolScalarCommonTasks

Method detail#

CalculationToolScalarCommonTasks.quick_evaluate_array_for_calculation_scalar_array(self, times: list, calc_array_vec: list) list#

Each calc scalar in calcArrayVec is evaluated over the array of input times returning the results as an array of elements for each time, each element being an array of results for each calc scalar, results being an array…

Parameters:

times : list

calc_array_vec : list

Returns:

list

CalculationToolScalarCommonTasks.quick_evaluate_event_array_for_calculation_scalar_array(self, ref_array: ITimeToolTimeArray, calc_array_vec: list) list#

Each calc scalar in calcArrayVec is evaluated over the array of times provided by refArray returning results as an array of elements for each time, each element being an array of results for each calc scalar, results being an array…

Parameters:

ref_array : ITimeToolTimeArray

calc_array_vec : list

Returns:

list

CalculationToolScalarCommonTasks.quick_evaluate_for_calculation_scalar_array(self, epoch: Any, calc_array_vec: list) list#

Each calc scalar in calcArrayVec is evaluated at epoch returning results as an array of elements, where each element is itself an array with two elements: 1. success (boolean) 2. value (double-precision).

Parameters:

epoch : Any

calc_array_vec : list

Returns:

list

CalculationToolScalarCommonTasks.quick_evaluate_with_rate_array_for_calculation_scalar_array(self, times: list, calc_array_vec: list) list#

Each calc scalar in calcArrayVec is evaluated over the array of input times returning the results as an array of elements for each time, each element being an array of results for each calc scalar, results being an array…

Parameters:

times : list

calc_array_vec : list

Returns:

list

CalculationToolScalarCommonTasks.quick_evaluate_with_rate_event_array_for_calculation_scalar_array(self, ref_array: ITimeToolTimeArray, calc_array_vec: list) list#

Each calc scalar in calcArrayVec is evaluated over the array of times provided by refArray returning results as an array of elements for each time, each element being an array of results for each calc scalar, results being an array…

Parameters:

ref_array : ITimeToolTimeArray

calc_array_vec : list

Returns:

list

CalculationToolScalarCommonTasks.quick_evaluate_with_rate_for_calculation_scalar_array(self, epoch: Any, calc_array_vec: list) list#

Each calc scalar in calcArrayVec is evaluated at epoch returning results as an array of elements, where each element is itself an array with three elements: 1. success (boolean) 2. value (double-precision) 3. value rate (double-precision).

Parameters:

epoch : Any

calc_array_vec : list

Returns:

list