CalculationToolSamplingRelativeTolerance#

class ansys.stk.core.analysis_workbench.CalculationToolSamplingRelativeTolerance#

Bases: ICalculationToolSamplingMethod

Relative tolerance definition includes parameters that determine how scalar data should be sampled based on limits on difference between actual changes between samples and changes predicted by dead reckoning.

Overview#

absolute_tolerance

Get the absolute tolerance which determines acceptable difference between predicted and actual changes in values of sampled data over a step.

maximum_time_step

Get the maximum allowed time step.

minimum_time_step

Get the minimum allowed time step.

relative_tolerance

Get the relative tolerance which determines acceptable difference between predicted and actual changes in values of sampled data over a step relative to the sampled values.

step_at_boundaries

Get the step taken at boundaries of discontinuity or availability.

Import detail#

from ansys.stk.core.analysis_workbench import CalculationToolSamplingRelativeTolerance

Property detail#

property CalculationToolSamplingRelativeTolerance.absolute_tolerance: float#

Get the absolute tolerance which determines acceptable difference between predicted and actual changes in values of sampled data over a step.

property CalculationToolSamplingRelativeTolerance.maximum_time_step: float#

Get the maximum allowed time step.

property CalculationToolSamplingRelativeTolerance.minimum_time_step: float#

Get the minimum allowed time step.

property CalculationToolSamplingRelativeTolerance.relative_tolerance: float#

Get the relative tolerance which determines acceptable difference between predicted and actual changes in values of sampled data over a step relative to the sampled values.

property CalculationToolSamplingRelativeTolerance.step_at_boundaries: float#

Get the step taken at boundaries of discontinuity or availability.