evaluate

VectorReal.evaluate(name: str | None = None, setup: str | None = None, intrinsics: dict | None = None, assignment=None) → float

Register and evaluate this expression to a single value.

Parameters:

namestr, optional

Named-expression name. A unique one is generated when not provided.

setupstr, optional

Solution name, for example "Setup1 : LastAdaptive".

intrinsicsdict, optional

Intrinsic variables (Freq / Time / Phase).

assignmentoptional

Forwarded to add().

Returns:

float

The evaluated value.

Examples

Register an expression and forward evaluation to the calculator.

>>> calc = type(
...     "Calc",
...     (),
...     {
...         "design_type": "HFSS",
...         "add_expression": staticmethod(lambda *args, **kwargs: kwargs["name"]),
...         "evaluate": staticmethod(lambda *args, **kwargs: 3.14),
...     },
... )()
>>> from ansys.aedt.core.visualization.post.field_calculator_expressions import FieldExpressions
>>> fx = FieldExpressions(calc)
>>> fx.vector("E").magnitude().evaluate(name="e_mag")
3.14