ScalarReal

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

Examples

Start from a real scalar quantity and apply scalar operations.

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

Methods

ScalarReal.absolute()	Absolute value |s| (calculator Abs).
ScalarReal.acos()	Arccosine (calculator trig Acos).
ScalarReal.add(name[, assignment])	Register this expression as an AEDT named expression.
ScalarReal.as_complex_imag()	Use this real scalar as the imaginary part of a complex number (calculator CmplxI).
ScalarReal.as_complex_real()	Use this real scalar as the real part of a complex number (calculator CmplxR).
ScalarReal.as_vector_x()	Place this scalar in the x component of a vector (calculator VecX).
ScalarReal.as_vector_y()	Place this scalar in the y component of a vector (calculator VecY).
ScalarReal.as_vector_z()	Place this scalar in the z component of a vector (calculator VecZ).
ScalarReal.asin()	Arcsine (calculator trig Asin).
ScalarReal.atan()	Arctangent (calculator trig Atan).
ScalarReal.checkpoint([name])	Register this expression and return a single-entry reference to it.
ScalarReal.cos()	Cosine (calculator trig Cos).
ScalarReal.derivative(axis)	Partial derivative ∂s/∂axis for axis in {"x", "y", "z"} (calculator d/dx / d/dy / d/dz).
ScalarReal.evaluate([name, setup, ...])	Register and evaluate this expression to a single value.
ScalarReal.export(output_file[, name])	Register and export this expression to a field file.
ScalarReal.gradient()	Gradient (calculator Grad).
ScalarReal.integrate(over)	Integrate over a geometry ∫ s dΩ (calculator Integrate).
ScalarReal.ln()	Natural logarithm (calculator ln).
ScalarReal.log10()	Base-10 logarithm (calculator log).
ScalarReal.max_position(over)	Position of the maximum over a geometry (calculator MaxPos).
ScalarReal.maximum(over)	Maximum over a geometry (calculator Maximum).
ScalarReal.mean(over)	Mean over a geometry (calculator Mean).
ScalarReal.min_position(over)	Position of the minimum over a geometry (calculator MinPos).
ScalarReal.minimum(over)	Minimum over a geometry (calculator Minimum).
ScalarReal.power(exponent)	Constant power (calculator Pow).
ScalarReal.sin()	Sine (calculator trig Sin).
ScalarReal.smooth()	Smooth the quantity across the mesh (calculator Smooth).
ScalarReal.sqrt()	Square root (calculator Sqrt).
ScalarReal.stack_depth()	Net Fields Calculator stack depth after applying all operations.
ScalarReal.std(over)	Standard deviation over a geometry (calculator Std).
ScalarReal.tan()	Tangent (calculator trig Tan).
ScalarReal.to_dict(name[, assignment])	Compile this expression to a Fields Calculator expression dictionary.
ScalarReal.value(over)	Sample the quantity on a geometry without integrating.
ScalarReal.verify()	Validate that the operation chain is well-formed and return self.

Attributes

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