flowplane.zone.velocity

Syntax

v := flowplane.zone.velocity(fpzp)

Get the flow velocity. This is the discharge divided by the average zone aperture. Units are length/time.

Returns:

v - velocity

Arguments:

fpzp - flow plane zone pointer

Component Access

f := flowplane.zone.velocity (fpzp)->x

f := flowplane.zone.velocity.x(fpzp)

Get the \(x\)-component of the flow velocity. This is the discharge divided by the average zone aperture. Units are length/time.

Returns:

f - \(x\)-component of velocity

Arguments:

fpzp - flow plane zone pointer

Access other vector components (\(y\), \(z\)) by substituting the component name where \(x\) appears above. See Member Access Operator for information about accessing members from data types using ->.

Deprecated Component Access

Component access by adding an optional integer in the function arguments (flowplane.zone.velocity(fpzp,<int>)) is deprecated. It remains available but will not be supported in future versions. See Component Access with Integers in FISH on the Deprecated Commands and FISH page for details.

This is hidden. Added to include remaining vector component access functions for inline help.

f := flowplane.zone.velocity.y(fpzp)

f := flowplane.zone.velocity.z(fpzp)