CalculationToolConvergeBasic#

class ansys.stk.core.analysis_workbench.CalculationToolConvergeBasic#

Convergence definition includes parameters that determine criteria for accurate detection of extrema or condition crossings for scalar calculations.

Overview#

Properties

`sense`	Get the convergence sense which determines whether the converged value should be limited to just within or just outside of condition boundaries.
`time_tolerance`	Get the time tolerance which determines the time accuracy of the converged value.
`absolute_tolerance`	Get the absolute tolerance which determines the distance between the value and the boundaries within which the value is considered converged.
`relative_tolerance`	Get the relative tolerance which determines the relative distance between the value and the boundaries within which the value is considered converged.

from ansys.stk.core.analysis_workbench import CalculationToolConvergeBasic

property CalculationToolConvergeBasic.sense: ThresholdConvergenceSenseType#: Get the convergence sense which determines whether the converged value should be limited to just within or just outside of condition boundaries.

property CalculationToolConvergeBasic.time_tolerance: float#: Get the time tolerance which determines the time accuracy of the converged value.

property CalculationToolConvergeBasic.absolute_tolerance: float#: Get the absolute tolerance which determines the distance between the value and the boundaries within which the value is considered converged.

property CalculationToolConvergeBasic.relative_tolerance: float#: Get the relative tolerance which determines the relative distance between the value and the boundaries within which the value is considered converged.