bl_scalar#
- ens_calculator.bl_scalar(source_parts: List[ENS_PART] | List[int] | List[str], velocity: ENS_VAR | str | int, scalar: ENS_VAR | str | int, ymax: float, opt_for_a_gradient_of_velo_mag: ENS_VAR | str | int, output_varname: str | None = None) ENS_VAR #
Computes a scalar variable defined as the scalar value of the corresponding scalar field at the edge of the boundary layer.
- Args:
- source_parts:
Any boundary part(s) or a boundary part number.
- velocity:
A velocity variable.
- scalar:
A scalar variable.
- ymax:
A ymax profiling distance (>0), (enter 0 for convergence alg.).
- 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_Scalar() for function details.