ScalarComplex

class ansys.aedt.core.visualization.post.field_calculator_expressions.ScalarComplex(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 scalar Fields Calculator quantity.

Examples

Start from a complex scalar quantity and extract derived values.

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

Methods

ScalarComplex.add(name[, assignment])	Register this expression as an AEDT named expression.
ScalarComplex.as_vector_x()	Place this scalar in the x component of a vector (calculator VecX).
ScalarComplex.as_vector_y()	Place this scalar in the y component of a vector (calculator VecY).
ScalarComplex.as_vector_z()	Place this scalar in the z component of a vector (calculator VecZ).
ScalarComplex.at_phase(phase_deg)	Real value at a given phase angle in degrees (calculator AtPhase).
ScalarComplex.checkpoint([name])	Register this expression and return a single-entry reference to it.
ScalarComplex.conjugate()	Complex conjugate (calculator Conj).
ScalarComplex.evaluate([name, setup, ...])	Register and evaluate this expression to a single value.
ScalarComplex.export(output_file[, name])	Register and export this expression to a field file.
ScalarComplex.imaginary()	Imaginary part (calculator Imag).
ScalarComplex.integrate(over)	Integrate over a geometry ∫ s dΩ (calculator Integrate).
ScalarComplex.magnitude()	Complex magnitude |s| (calculator CmplxMag).
ScalarComplex.mean(over)	Mean over a geometry (calculator Mean).
ScalarComplex.phase()	Phase angle of the complex quantity (calculator CmplxPhase).
ScalarComplex.real()	Real part (calculator Real).
ScalarComplex.smooth()	Smooth the quantity across the mesh (calculator Smooth).
ScalarComplex.stack_depth()	Net Fields Calculator stack depth after applying all operations.
ScalarComplex.to_dict(name[, assignment])	Compile this expression to a Fields Calculator expression dictionary.
ScalarComplex.value(over)	Sample the quantity on a geometry without integrating.
ScalarComplex.verify()	Validate that the operation chain is well-formed and return self.

Attributes

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