helicityrelfilter

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

Computes a scalar variable defined as the relative filtered helicity = the relative helicity if the helicity density is greater or equal to the filter value and = 0 if the helicity density is less than the filter value. The filter value is defined to be .1*Vinf^2 where Vinf is the freestream velocity magnitude

Args:

source_parts:

Any part(s) or a part number.

velocity:

A velocity variable.

free_velocity:

A ‘freestream velocity magnitude’ variable or value(>=1.0)

output_varname:

The name of the newly created variable

Returns:

New ENS_VAR instance or None

Note:

See HelicityRelFilter() for function details.