CalculationToolScalarAverage

class ansys.stk.core.analysis_workbench.CalculationToolScalarAverage

Bases: ICalculationToolScalar, IAnalysisWorkbenchComponent

Integral of input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.

Overview

Methods

set_offsets

Set the offsets with respect to current time to define the start and stop of the sliding window, used when IntegrationWindowType is set to Sliding Window.

Properties

input_scalar	The input scalar calculation.
compute_as_average	Specify whether the resulting integral value is divided by its time span to generate average value instead of integral.
integration_window_type	The integration window, or accumulation, type.
start_offset	Set the offset with respect to current time to define the start of the sliding window, used when IntegrationWindowType is set to Sliding Window.
stop_offset	Set the offset with respect to current time to define the stop of the sliding window, used when IntegrationWindowType is set to Sliding Window.
use_custom_time_limits	Specify whether to use custom interval list (CustomTimeLimits).
custom_time_limits	The interval list within which the global minimum or maximum is sought. The default is the overall availability of host object.
save_data_option	Set the value to determine if computed time of extremum is saved/loaded, or recomputed on load if necessary.
interpolation	Specify whether to use Lagrange or Hermite interpolation. See STK help on interpolation.
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…
integral	The numerical integration method.
keep_constant_outside_time_limits	If true, the integral’s integrand value is replaced by a constant 0 so that the integral remains constant over the gaps in integration.

Import detail

from ansys.stk.core.analysis_workbench import CalculationToolScalarAverage

Property detail

property CalculationToolScalarAverage.input_scalar: ICalculationToolScalar

The input scalar calculation.

property CalculationToolScalarAverage.compute_as_average: bool

Specify whether the resulting integral value is divided by its time span to generate average value instead of integral.

property CalculationToolScalarAverage.integration_window_type: IntegrationWindowType

The integration window, or accumulation, type.

property CalculationToolScalarAverage.start_offset: float

Set the offset with respect to current time to define the start of the sliding window, used when IntegrationWindowType is set to Sliding Window.

property CalculationToolScalarAverage.stop_offset: float

Set the offset with respect to current time to define the stop of the sliding window, used when IntegrationWindowType is set to Sliding Window.

property CalculationToolScalarAverage.use_custom_time_limits: bool

Specify whether to use custom interval list (CustomTimeLimits).

property CalculationToolScalarAverage.custom_time_limits: ITimeToolTimeIntervalList

The interval list within which the global minimum or maximum is sought. The default is the overall availability of host object.

property CalculationToolScalarAverage.save_data_option: SaveDataType

Set the value to determine if computed time of extremum is saved/loaded, or recomputed on load if necessary.

property CalculationToolScalarAverage.interpolation: IAnalysisWorkbenchInterpolator

Specify whether to use Lagrange or Hermite interpolation. See STK help on interpolation.

property CalculationToolScalarAverage.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 CalculationToolScalarAverage.integral: IAnalysisWorkbenchIntegral

The numerical integration method.

property CalculationToolScalarAverage.keep_constant_outside_time_limits: bool

If true, the integral’s integrand value is replaced by a constant 0 so that the integral remains constant over the gaps in integration.

Method detail

CalculationToolScalarAverage.set_offsets(self, start_offset: float, stop_offset: float) → None

Set the offsets with respect to current time to define the start and stop of the sliding window, used when IntegrationWindowType is set to Sliding Window.

Parameters:

start_offset : float

stop_offset : float

Returns:

None