CalculationToolScalarFunction#

class ansys.stk.core.analysis_workbench.CalculationToolScalarFunction#

Bases: ICalculationToolScalar, IAnalysisWorkbenchComponent

Defined by performing the specified function on the input scalar or time instant.

Overview#

Properties

`use_calculation_scalar`	Specify whether to use the input scalar calculation or the time elapsed from the input time instant. Set to true to use the scalar.
`input_scalar`	The input scalar calculation (used if UseScalar is true). The UseScalar property should be set to true before this property can be set.
`input_time`	The input time instant (used if UseScalar is false).
`input_time_units`	The input time unit to interpret input time.
`coefficient_a`	The constant coefficient A.
`coefficient_b`	The constant coefficient B.
`coefficient_c`	The constant coefficient C.
`coefficient_d`	The constant coefficient D.
`coefficients`	The array of constant coefficients, whose dimension and units are determined by those of input and output.
`selected_function`	The function which will use the input scalar or time instant in some combination with the constant coefficients A, B, C, D.
`available_functions`	Get the available function names.
`inherit_dimension_from_input`	Specify whether to inherit the output dimension from the input scalar or time instant.
`output_dimension`	The output dimension. Use any of STK supported dimensions. This value will be used if InheritDimensionFromInput is false. The InheritDimensionFromInput property should be set to false before this property can be fixed.
`output_units`	Specify a unit for the selected output dimension. This is not used for internal computations or reporting/graphing but is needed to unambiguously interpret units of associated coefficients.
`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…
`convergence`	The Convergence definition, which uses time tolerance to determine when time of extremum is found.

Import detail#

from ansys.stk.core.analysis_workbench import CalculationToolScalarFunction

Property detail#

property CalculationToolScalarFunction.use_calculation_scalar: bool#: Specify whether to use the input scalar calculation or the time elapsed from the input time instant. Set to true to use the scalar.

property CalculationToolScalarFunction.input_scalar: ICalculationToolScalar#: The input scalar calculation (used if UseScalar is true). The UseScalar property should be set to true before this property can be set.

property CalculationToolScalarFunction.input_time: ITimeToolInstant#: The input time instant (used if UseScalar is false).

property CalculationToolScalarFunction.input_time_units: str#: The input time unit to interpret input time.

property CalculationToolScalarFunction.coefficient_a: float#: The constant coefficient A.

property CalculationToolScalarFunction.coefficient_b: float#: The constant coefficient B.

property CalculationToolScalarFunction.coefficient_c: float#: The constant coefficient C.

property CalculationToolScalarFunction.coefficient_d: float#: The constant coefficient D.

property CalculationToolScalarFunction.coefficients: list#: The array of constant coefficients, whose dimension and units are determined by those of input and output.

property CalculationToolScalarFunction.selected_function: str#: The function which will use the input scalar or time instant in some combination with the constant coefficients A, B, C, D.

property CalculationToolScalarFunction.available_functions: list#: Get the available function names.

property CalculationToolScalarFunction.inherit_dimension_from_input: bool#: Specify whether to inherit the output dimension from the input scalar or time instant.

property CalculationToolScalarFunction.output_dimension: str#: The output dimension. Use any of STK supported dimensions. This value will be used if InheritDimensionFromInput is false. The InheritDimensionFromInput property should be set to false before this property can be fixed.

property CalculationToolScalarFunction.output_units: str#: Specify a unit for the selected output dimension. This is not used for internal computations or reporting/graphing but is needed to unambiguously interpret units of associated coefficients.

property CalculationToolScalarFunction.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 CalculationToolScalarFunction.convergence: IAnalysisWorkbenchConvergence#: The Convergence definition, which uses time tolerance to determine when time of extremum is found.