CalculationToolConditionScalarBounds

class ansys.stk.core.analysis_workbench.CalculationToolConditionScalarBounds

Bases: ICalculationToolCondition, IAnalysisWorkbenchComponent

Defined by determining if input scalar is within specified bounds; returns +1 if satisfied, -1 if not satisfied and 0 if on boundary.

Overview

Methods

get_maximum	Get the maximum bound value from the condition. Call SetMaximum to apply changes.
get_maximum_unitless	Get the unitless maximum bound value from the condition. Call SetMaximum to apply changes.
get_minimum	Get the minimum bound value from the condition. Call SetMinimum to apply changes.
get_minimum_unitless	Get the unitless minimum bound value from the condition. Call SetMinimum to apply changes.
set	Set the min/max bounds. Throws an exception if the minimum is greater than maximum.
set_maximum	Set the maximum bound value for the condition.
set_maximum_unitless	Set the unitless maximum bound value for the condition.
set_minimum	Set the minimum bound value for the condition.
set_minimum_unitless	Set the unitless minimum bound value for the condition.
set_unitless	Set the unitless min/max bounds. Throws an exception if the minimum is greater than maximum.

Properties

operation	Get the operation from the condition that determines how the bounds are considered. The operation can be set to define satisfaction when the scalar is above minimum, below maximum, between minimum and maximum or outside minimum and maximum.
scalar	Get the scalar calculation from the condition.

Import detail

from ansys.stk.core.analysis_workbench import CalculationToolConditionScalarBounds

Property detail

property CalculationToolConditionScalarBounds.operation: ConditionThresholdType

Get the operation from the condition that determines how the bounds are considered. The operation can be set to define satisfaction when the scalar is above minimum, below maximum, between minimum and maximum or outside minimum and maximum.

property CalculationToolConditionScalarBounds.scalar: ICalculationToolScalar

Get the scalar calculation from the condition.

Method detail

CalculationToolConditionScalarBounds.get_maximum(self) → Quantity

Get the maximum bound value from the condition. Call SetMaximum to apply changes.

Returns:

Quantity

CalculationToolConditionScalarBounds.get_maximum_unitless(self) → float

Get the unitless maximum bound value from the condition. Call SetMaximum to apply changes.

Returns:

float

CalculationToolConditionScalarBounds.get_minimum(self) → Quantity

Get the minimum bound value from the condition. Call SetMinimum to apply changes.

Returns:

Quantity

CalculationToolConditionScalarBounds.get_minimum_unitless(self) → float

Get the unitless minimum bound value from the condition. Call SetMinimum to apply changes.

Returns:

float

CalculationToolConditionScalarBounds.set(self, min: Quantity, max: Quantity) → None

Set the min/max bounds. Throws an exception if the minimum is greater than maximum.

Parameters:

min : Quantity

max : Quantity

Returns:

None

CalculationToolConditionScalarBounds.set_maximum(self, value: Quantity) → None

Set the maximum bound value for the condition.

Parameters:

value : Quantity

Returns:

None

CalculationToolConditionScalarBounds.set_maximum_unitless(self, value: float) → None

Set the unitless maximum bound value for the condition.

Parameters:

value : float

Returns:

None

CalculationToolConditionScalarBounds.set_minimum(self, value: Quantity) → None

Set the minimum bound value for the condition.

Parameters:

value : Quantity

Returns:

None

CalculationToolConditionScalarBounds.set_minimum_unitless(self, value: float) → None

Set the unitless minimum bound value for the condition.

Parameters:

value : float

Returns:

None

CalculationToolConditionScalarBounds.set_unitless(self, min: float, max: float) → None

Set the unitless min/max bounds. Throws an exception if the minimum is greater than maximum.

Parameters:

min : float

max : float

Returns:

None