ICalculationToolCondition

class ansys.stk.core.analysis_workbench.ICalculationToolCondition

Condition returns a non-dimensional metric that is positive if satisfied, negative if not satisfied and 0 if on boundary; this provides computational methods needed for accurate detection of condition crossings.

Overview

Methods

evaluate	Return result of evaluating continuously varying condition metric at the specified time, used for detecting condition crossings.
evaluate_with_rate	Return result of evaluating continuously varying condition metric and its rate of change at the specified time, used for detecting condition crossings.

Properties

type	Return the type of condition.

Import detail

from ansys.stk.core.analysis_workbench import ICalculationToolCondition

Property detail

property ICalculationToolCondition.type: ConditionType

Return the type of condition.

Method detail

ICalculationToolCondition.evaluate(self, epoch: Any) → CalculationToolEvaluateResult

Return result of evaluating continuously varying condition metric at the specified time, used for detecting condition crossings.

Parameters:

epoch : Any

Returns:

CalculationToolEvaluateResult

ICalculationToolCondition.evaluate_with_rate(self, epoch: Any) → CalculationToolEvaluateWithRateResult

Return result of evaluating continuously varying condition metric and its rate of change at the specified time, used for detecting condition crossings.

Parameters:

epoch : Any

Returns:

CalculationToolEvaluateWithRateResult