VectorComplex

class ansys.aedt.core.visualization.post.field_calculator_expressions.VectorComplex(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 complex 3-vector Fields Calculator quantity.

Examples

Start from a complex vector quantity and derive scalar projections.

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

Methods

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

Attributes

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