ICalculationToolConditionSet

class ansys.stk.core.analysis_workbench.ICalculationToolConditionSet

Condition set returns an array of non-dimensional metrics, one for each condition in the set; each metric is positive if corresponding condition is satisfied, negative if not satisfied and 0 if on boundary; this provides computational methods needed for…

Overview

Methods

evaluate	Return an array of results of evaluating continuously varying condition metrics, one for each condition in the set, at the specified time, used for detecting condition crossings.
evaluate_with_rate	Return an array of results of evaluating continuously varying condition metrics and their rates of change, one for each condition in the set, at the specified time, used for detecting condition crossings.

Properties

type	Return the type of condition set.

Import detail

from ansys.stk.core.analysis_workbench import ICalculationToolConditionSet

Property detail

property ICalculationToolConditionSet.type: ConditionSetType

Return the type of condition set.

Method detail

ICalculationToolConditionSet.evaluate(self, epoch: Any) → CalculationToolConditionSetEvaluateResult

Return an array of results of evaluating continuously varying condition metrics, one for each condition in the set, at the specified time, used for detecting condition crossings.

Parameters:

epoch : Any

Returns:

CalculationToolConditionSetEvaluateResult

ICalculationToolConditionSet.evaluate_with_rate(self, epoch: Any) → CalculationToolConditionSetEvaluateWithRateResult

Return an array of results of evaluating continuously varying condition metrics and their rates of change, one for each condition in the set, at the specified time, used for detecting condition crossings.

Parameters:

epoch : Any

Returns:

CalculationToolConditionSetEvaluateWithRateResult