vectorcylprojection#

ens_calculator.vectorcylprojection(source_parts: List[ENS_PART] | List[int] | List[str] | ENS_PART | int | str, vector_to_project: ENS_VAR | str | int, frame_number: int, which_axis: int = 0, output_varname: str | None = None) ENS_VAR#

Computes a vector variable defined as the specified vector variable projected onto a frame’s axis, radial, or theta direction

Args:
source_parts:

Any part(s) or a part number.

vector_to_project:

A vector variable.

frame_number:

A constant variable name or a constant value.

which_axis:

Select the cylindrical axis to compute.

output_varname:

The name of the newly created variable

Returns:

New ENS_VAR instance or None

Note:

See VectorCylProjection() for function details.