VectorReal

class ansys.aedt.core.visualization.post.field_calculator_expressions.VectorReal(operations: Sequence[str], *, calculator=None, description: str = '', design_type: list[str] | None = None, fields_type: list[str] | None = None, assignment_types: list[str] | None = None, primary_sweep: str = 'Freq', solution_type: str = '')

A real 3-vector Fields Calculator quantity.

Examples

Start from a real vector quantity and derive scalar components.

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

Methods

VectorReal.add(name[, assignment])	Register this expression as an AEDT named expression.
VectorReal.checkpoint([name])	Register this expression and return a single-entry reference to it.
VectorReal.curl()	Curl ∇×v (calculator Curl).
VectorReal.divergence()	Divergence ∇·v (calculator Divg).
VectorReal.evaluate([name, setup, ...])	Register and evaluate this expression to a single value.
VectorReal.export(output_file[, name])	Register and export this expression to a field file.
VectorReal.magnitude()	Vector magnitude ‖v‖ (calculator Mag).
VectorReal.scalar_x()	X component (calculator ScalarX).
VectorReal.scalar_y()	Y component (calculator ScalarY).
VectorReal.scalar_z()	Z component (calculator ScalarZ).
VectorReal.smooth()	Smooth the quantity across the mesh (calculator Smooth).
VectorReal.stack_depth()	Net Fields Calculator stack depth after applying all operations.
VectorReal.to_dict(name[, assignment])	Compile this expression to a Fields Calculator expression dictionary.
VectorReal.verify()	Validate that the operation chain is well-formed and return self.

Attributes

VectorReal.is_complex
VectorReal.is_vector
VectorReal.operations	Copy of the calculator operation stack this expression compiles to.
VectorReal.public_dir	Shortcut for dir(self).