TimeToolInstantExtremum

class ansys.stk.core.analysis_workbench.TimeToolInstantExtremum

Bases: ITimeToolInstant, IAnalysisWorkbenchComponent

Determine time of global minimum 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	A Convergence definition, which uses time tolerance to determine when time of extremum is found.
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.
extremum_type	The extremum type of interest (either minimum or maximum) for scalar calculation.
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…
save_data_option	Determine if computed time of extremum is 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 TimeToolInstantExtremum

Property detail

property TimeToolInstantExtremum.calculation_scalar: ICalculationToolScalar

The scalar calculation.

property TimeToolInstantExtremum.convergence: IAnalysisWorkbenchConvergence

A Convergence definition, which uses time tolerance to determine when time of extremum is found.

property TimeToolInstantExtremum.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 TimeToolInstantExtremum.extremum_type: ExtremumType

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

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

Determine if computed time of extremum is saved/loaded, otherwise it is recomputed on load if necessary.

property TimeToolInstantExtremum.use_custom_time_limits: bool

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