TimeToolTimeArrayExtrema

class ansys.stk.core.analysis_workbench.TimeToolTimeArrayExtrema

Bases: ITimeToolTimeArray, IAnalysisWorkbenchComponent

Determine times of local minimum and/or maximum of specified scalar calculation. Determination is performed within interval list using Sampling and Convergence parameters.

Overview

Properties

calculation_scalar	The scalar calculation.
convergence	The Convergence definition, which uses time tolerance to determine when times of extrema are found.
custom_time_limits	A custom interval list or a single interval. It is by default set to overall availability of host object. This determines time limits within extrema are sought. The time limits will be used if UseCustomTimeLimits is set to true.
extremum_type	The extremum type of interest (either minimum or maximum) for scalar calculation.
is_global	Indicate whether to perform local or global search. The default is false.
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…
save_data_option	Specify whether computed times of extrema are saved/loaded, otherwise it is recomputed on load if necessary.
use_custom_time_limits	Indicate whether to use specified custom time limits (see CustomTimeLimits).

Import detail

from ansys.stk.core.analysis_workbench import TimeToolTimeArrayExtrema

Property detail

property TimeToolTimeArrayExtrema.calculation_scalar: ICalculationToolScalar

The scalar calculation.

property TimeToolTimeArrayExtrema.convergence: IAnalysisWorkbenchConvergence

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

property TimeToolTimeArrayExtrema.custom_time_limits: ITimeToolTimeIntervalList

A custom interval list or a single interval. It is by default set to overall availability of host object. This determines time limits within extrema are sought. The time limits will be used if UseCustomTimeLimits is set to true.

property TimeToolTimeArrayExtrema.extremum_type: ExtremumType

The extremum type of interest (either minimum or maximum) for scalar calculation.

property TimeToolTimeArrayExtrema.is_global: bool

Indicate whether to perform local or global search. The default is false.

property TimeToolTimeArrayExtrema.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 TimeToolTimeArrayExtrema.save_data_option: SaveDataType

Specify whether computed times of extrema are saved/loaded, otherwise it is recomputed on load if necessary.

property TimeToolTimeArrayExtrema.use_custom_time_limits: bool

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