swirl#

ens_calculator.swirl(source_parts: List[ENS_PART] | List[int] | List[str] | ENS_PART | int | str, density: ENS_VAR | str | int | float, velocity: ENS_VAR | str | int, output_varname: str | None = None) ENS_VAR#

Computes a scalar variable defined as the swirl. Function of density and velocity

Args:
source_parts:

Any part(s) or a part number.

density:

A density variable or a value.

velocity:

A velocity variable.

output_varname:

The name of the newly created variable

Returns:

New ENS_VAR instance or None

Note:

See Swirl() for function details.