bl_y1plusdist#

ens_calculator.bl_y1plusdist(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 off-the-wall distance to the 1st field cell centroid. (Note: Velocity only used to determine reference sense (nodal or elemental) of variable to coincide with BL_Y1Plus.)

Args:
source_parts:

Any boundary part(s) or a boundary part number.

velocity:

A velocity variable.

output_varname:

The name of the newly created variable

Returns:

New ENS_VAR instance or None

Note:

See BL_Y1PlusDist() for function details.