TimeToolTimeIntervalCollectionCondition#

class ansys.stk.core.analysis_workbench.TimeToolTimeIntervalCollectionCondition#

Bases: ITimeToolTimeIntervalCollection, IAnalysisWorkbenchComponent

Interval list containing intervals during which specified condition is satisfied. Determination is performed within interval list using Sampling and Convergence parameters.

Overview#

Properties

`condition_set`	Get/set the condition set object.
`custom_time_limits`	A custom interval list or a single interval. By default it is set to overall availability of host object. This determines time limits within which global minimum or maximum is sought. The time limits will be used if UseCustomTimeLimits is set to true.
`use_custom_time_limits`	Specify whether to use specified custom interval list (see CustomTimeLimits).
`save_data_option`	Determine if computed time of extremum is saved/loaded, otherwise it is recomputed on load if necessary.
`sampling`	A Sampling definition, which can use a fixed step, relative tolerance or curvature tolerance. Relative tolerance uses a combination of relative and absolute changes in scalar values between samples…
`convergence`	A Convergence definition, which uses time tolerance to determine when time of extremum is found.

Import detail#

from ansys.stk.core.analysis_workbench import TimeToolTimeIntervalCollectionCondition

Property detail#

property TimeToolTimeIntervalCollectionCondition.condition_set: ICalculationToolConditionSet#: Get/set the condition set object.

property TimeToolTimeIntervalCollectionCondition.custom_time_limits: ITimeToolTimeIntervalList#: A custom interval list or a single interval. By default it is set to overall availability of host object. This determines time limits within which global minimum or maximum is sought. The time limits will be used if UseCustomTimeLimits is set to true.

property TimeToolTimeIntervalCollectionCondition.use_custom_time_limits: bool#: Specify whether to use specified custom interval list (see CustomTimeLimits).

property TimeToolTimeIntervalCollectionCondition.save_data_option: SaveDataType#: Determine if computed time of extremum is saved/loaded, otherwise it is recomputed on load if necessary.

property TimeToolTimeIntervalCollectionCondition.sampling: IAnalysisWorkbenchSampling#: A Sampling definition, which can use a fixed step, relative tolerance or curvature tolerance. Relative tolerance uses a combination of relative and absolute changes in scalar values between samples…

property TimeToolTimeIntervalCollectionCondition.convergence: IAnalysisWorkbenchConvergence#: A Convergence definition, which uses time tolerance to determine when time of extremum is found.