TimeToolTimeArrayConditionCrossings#

class ansys.stk.core.analysis_workbench.TimeToolTimeArrayConditionCrossings#

Bases: ITimeToolTimeArray, IAnalysisWorkbenchComponent

Time array containing times at which the specified condition will change its satisfaction status. Determination is performed within the interval list using Sampling and Convergence parameters.

Overview#

satisfaction_crossing

The direction of interest for satisfaction crossing.

condition

The condition component.

custom_time_limits

Specify the interval list within which satisfaction crossing times are sought. The default is set to overall availability of host object. The time limits will be used if UseCustomTimeLimits is set to true.

use_custom_time_limits

Indicate whether to use specified custom time limits (see CustomTimeLimits).

save_data_option

Determine if computed satisfaction crossing times are saved/loaded, or recomputed on load if necessary.

sampling

The 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

The Convergence definition, which uses time tolerance to determine when crossing times are found.

Import detail#

from ansys.stk.core.analysis_workbench import TimeToolTimeArrayConditionCrossings

Property detail#

property TimeToolTimeArrayConditionCrossings.satisfaction_crossing: SatisfactionCrossing#

The direction of interest for satisfaction crossing.

property TimeToolTimeArrayConditionCrossings.condition: ICalculationToolCondition#

The condition component.

property TimeToolTimeArrayConditionCrossings.custom_time_limits: ITimeToolTimeIntervalList#

Specify the interval list within which satisfaction crossing times are sought. The default is set to overall availability of host object. The time limits will be used if UseCustomTimeLimits is set to true.

property TimeToolTimeArrayConditionCrossings.use_custom_time_limits: bool#

Indicate whether to use specified custom time limits (see CustomTimeLimits).

property TimeToolTimeArrayConditionCrossings.save_data_option: SaveDataType#

Determine if computed satisfaction crossing times are saved/loaded, or recomputed on load if necessary.

property TimeToolTimeArrayConditionCrossings.sampling: IAnalysisWorkbenchSampling#

The 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 TimeToolTimeArrayConditionCrossings.convergence: IAnalysisWorkbenchConvergence#

The Convergence definition, which uses time tolerance to determine when crossing times are found.