CalculationToolScalarFile

class ansys.stk.core.analysis_workbench.CalculationToolScalarFile

Bases: ICalculationToolScalar, IAnalysisWorkbenchComponent

Tabulated scalar calculation data loaded from specified file - a file with .csc extension.

Overview

Methods

reload	Reload the file specified with Filename property.
get_file_span	Compute the interval time span of the file.

Properties

filename	The path to an ASCII file with .csc extension.
file_interpolation_type	The interpolation method used with the data.
file_interpolation_order	The interpolation order used with the interpolation method to interrogate the data.
use_native_file_interpolation_settings	Flag indicating whether the interpolation method and order settings specified within the file, if any, will be honored.

Import detail

from ansys.stk.core.analysis_workbench import CalculationToolScalarFile

Property detail

property CalculationToolScalarFile.filename: str

The path to an ASCII file with .csc extension.

property CalculationToolScalarFile.file_interpolation_type: FileInterpolatorType

The interpolation method used with the data.

property CalculationToolScalarFile.file_interpolation_order: int

The interpolation order used with the interpolation method to interrogate the data.

property CalculationToolScalarFile.use_native_file_interpolation_settings: bool

Flag indicating whether the interpolation method and order settings specified within the file, if any, will be honored.

Method detail

CalculationToolScalarFile.reload(self) → None

Reload the file specified with Filename property.

Returns:

None

CalculationToolScalarFile.get_file_span(self) → TimeToolTimeIntervalResult

Compute the interval time span of the file.

Returns:

TimeToolTimeIntervalResult