scalar

FieldExpressions.scalar(quantity: str, is_complex: bool = True) → ScalarReal | ScalarComplex

Start from a fundamental scalar quantity.

Parameters:

quantitystr

AEDT scalar quantity name.

is_complexbool, optional

Whether the quantity should be treated as complex.

Returns:

ScalarReal | ScalarComplex

Typed scalar expression seeded with Fundamental_Quantity('<quantity>').

Examples

Create a scalar expression from a fundamental quantity.

>>> from ansys.aedt.core.visualization.post.field_calculator_expressions import FieldExpressions
>>> fx = FieldExpressions(calculator=None)
>>> fx.scalar("Phi", is_complex=False).operations
["Fundamental_Quantity('Phi')"]