CalculationToolScalarFunctionOf2Variables

class ansys.stk.core.analysis_workbench.CalculationToolScalarFunctionOf2Variables

Bases: ICalculationToolScalar, IAnalysisWorkbenchComponent

Defined by performing a function(x,y) on two scalar arguments.

Overview

Properties

x	The scalar argument X.
units_x	The unit used to interpret numerical values of scalar argument X.
coefficient_a	The constant coefficient A.
y	The scalar argument Y.
units_y	The unit used to interpret numerical values of scalar argument Y.
coefficient_b	The constant coefficient B.
coefficient_c	The constant coefficient C.
output_dimension_inheritance	Specify whether the output dimension is inherited or explicitly specified using OutputDimension.
output_dimension	The output dimension. Use any of STK supported dimensions. This value will be used if OutputDimensionInheritance is false.
available_functions	The available functions. A function(x,y) uses some combination of two scalar arguments x and y as well as one to three constant coefficients a, b, c.
selected_function	The selected function.
output_units	The unit for the selected dimension. The unit is not used for internal computations or reporting/graphing but is needed to unambiguously interpret units of associated coefficients.

Import detail

from ansys.stk.core.analysis_workbench import CalculationToolScalarFunctionOf2Variables

Property detail

property CalculationToolScalarFunctionOf2Variables.x: ICalculationToolScalar

The scalar argument X.

property CalculationToolScalarFunctionOf2Variables.units_x: str

The unit used to interpret numerical values of scalar argument X.

property CalculationToolScalarFunctionOf2Variables.coefficient_a: float

The constant coefficient A.

property CalculationToolScalarFunctionOf2Variables.y: ICalculationToolScalar

The scalar argument Y.

property CalculationToolScalarFunctionOf2Variables.units_y: str

The unit used to interpret numerical values of scalar argument Y.

property CalculationToolScalarFunctionOf2Variables.coefficient_b: float

The constant coefficient B.

property CalculationToolScalarFunctionOf2Variables.coefficient_c: float

The constant coefficient C.

property CalculationToolScalarFunctionOf2Variables.output_dimension_inheritance: InheritDimensionType

Specify whether the output dimension is inherited or explicitly specified using OutputDimension.

property CalculationToolScalarFunctionOf2Variables.output_dimension: str

The output dimension. Use any of STK supported dimensions. This value will be used if OutputDimensionInheritance is false.

property CalculationToolScalarFunctionOf2Variables.available_functions: list

The available functions. A function(x,y) uses some combination of two scalar arguments x and y as well as one to three constant coefficients a, b, c.

property CalculationToolScalarFunctionOf2Variables.selected_function: str

The selected function.

property CalculationToolScalarFunctionOf2Variables.output_units: str

The unit for the selected dimension. The unit is not used for internal computations or reporting/graphing but is needed to unambiguously interpret units of associated coefficients.