bl_velocityatedge

ens_calculator.bl_velocityatedge(source_parts: List[ENS_PART] | List[int] | List[str] | ENS_PART | int | str, velocity: ENS_VAR | str | int, ymax: float, edge_vector_option: int = 0, opt_for_a_gradient_of_velo_mag: str | int | ENS_VAR | None = None, output_varname: str | None = None) → ENS_VAR

Computes a vector variable defined as one of Ve, Vn, or Vp where Ve = velocity vector at edge of boundary layer, Vn = decomposed velocity vector normal to the wall at the edge of the boundary layer, or Vp = the decomposed velocity vector parallel to the wall at the edge of the boundary layer.

Args:

source_parts:

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

velocity:

A velocity variable.

ymax:

A ymax profiling distance (>0), (enter 0 for convergence alg.).

edge_vector_option:

Enter option to extract Velocity at edge of BL: 0=Vedge, or decomposed 1=Vparallel or 2=Vnormal to surface.

opt_for_a_gradient_of_velo_mag:

The gradient of the input velocity vector magnitude, or -1 to approximate it.

output_varname:

The name of the newly created variable

Returns:

New ENS_VAR instance or None

Note:

See BL_VelocityAtEdge() for function details.