CalculationToolScalarDataElement

class ansys.stk.core.analysis_workbench.CalculationToolScalarDataElement

Bases: ICalculationToolScalar, IAnalysisWorkbenchComponent

Any time-dependent data element from STK data providers available for parent STK object.

Overview

Methods

set	Set the data provider and the element name.
set_with_group	Set the data provider name, the element name, and data provider type name.

Properties

data_provider	The name of the data provider.
element_name	The name of the data element within the data provider.
group	A group name the data element is a part of. If the element is not a part of a group, the property will return an empty string.
interpolation	Specify whether to use Lagrange or Hermite interpolation. See STK help on interpolation.
sampling	Relative tolerance uses a combination of relative and absolute changes in scalar values between samples. Curvature tolerance also uses changes in slope between samples.
use_samples	If set to true, selected data provider is presampled over its entire availability span using sampling method specified in Advanced options…
save_data_option	Determine if computed samples are saved/loaded, otherwise if using samples they are recomputed on load.
invalid_data_indicator	Set the value to display in a report or graph when the actual value is not a valid real number.

Import detail

from ansys.stk.core.analysis_workbench import CalculationToolScalarDataElement

Property detail

property CalculationToolScalarDataElement.data_provider: str

The name of the data provider.

property CalculationToolScalarDataElement.element_name: str

The name of the data element within the data provider.

property CalculationToolScalarDataElement.group: str

A group name the data element is a part of. If the element is not a part of a group, the property will return an empty string.

property CalculationToolScalarDataElement.interpolation: IAnalysisWorkbenchInterpolator

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

property CalculationToolScalarDataElement.sampling: IAnalysisWorkbenchSampling

Relative tolerance uses a combination of relative and absolute changes in scalar values between samples. Curvature tolerance also uses changes in slope between samples.

property CalculationToolScalarDataElement.use_samples: bool

If set to true, selected data provider is presampled over its entire availability span using sampling method specified in Advanced options…

property CalculationToolScalarDataElement.save_data_option: SaveDataType

Determine if computed samples are saved/loaded, otherwise if using samples they are recomputed on load.

property CalculationToolScalarDataElement.invalid_data_indicator: float

Set the value to display in a report or graph when the actual value is not a valid real number.

Method detail

CalculationToolScalarDataElement.set(self, data_provider: str, element_name: str) → None

Set the data provider and the element name.

Parameters:

data_provider : str

element_name : str

Returns:

None

CalculationToolScalarDataElement.set_with_group(self, data_provider: str, type_name: str, element_name: str) → None

Set the data provider name, the element name, and data provider type name.

Parameters:

data_provider : str

type_name : str

element_name : str

Returns:

None