CalculationToolSamplingMethodFactory#

class ansys.stk.core.analysis_workbench.CalculationToolSamplingMethodFactory#: The factory creates sampling method components.

Overview#

Methods

`create_fixed_step`	Create a fixed time step sampling definition.
`create_curvature_tolerance`	Create a curvature tolerance sampling definition. Curvature tolerance uses changes in slope between samples.
`create_relative_tolerance`	Create a relative tolerance sampling definition. Relative tolerance uses a combination of relative and absolute changes in scalar values between samples.

Import detail#

from ansys.stk.core.analysis_workbench import CalculationToolSamplingMethodFactory

Method detail#

CalculationToolSamplingMethodFactory.create_fixed_step(self, fixed_step: float) → ICalculationToolSamplingMethod#

Create a fixed time step sampling definition.

Parameters:: fixed_step : float
Returns:: ICalculationToolSamplingMethod

CalculationToolSamplingMethodFactory.create_curvature_tolerance(self, curvature_tolerance: float) → ICalculationToolSamplingMethod#

Create a curvature tolerance sampling definition. Curvature tolerance uses changes in slope between samples.

Parameters:: curvature_tolerance : float
Returns:: ICalculationToolSamplingMethod

CalculationToolSamplingMethodFactory.create_relative_tolerance(self, relative_tolerance: float) → ICalculationToolSamplingMethod#

Create a relative tolerance sampling definition. Relative tolerance uses a combination of relative and absolute changes in scalar values between samples.

Parameters:: relative_tolerance : float
Returns:: ICalculationToolSamplingMethod