helicityrelative

ens_calculator.helicityrelative(source_parts: List[ENS_PART] | List[int] | List[str] | ENS_PART | int | str, velocity: ENS_VAR | str | int, output_varname: str | None = None) → ENS_VAR

Computes a scalar variable defined as the relative helicity computed by dotting the velocity with vorticity and dividing by the velocity and vorticity magnitudes.

Args:

source_parts:

Any part(s) or a part number.

velocity:

A velocity variable.

output_varname:

The name of the newly created variable

Returns:

New ENS_VAR instance or None

Note:

See HelicityRelative() for function details.