Collaboration diagram for Visual flow plane:

Visualization SimObject for displaying flow plane data.

Renders a plane showing flow field data (current vectors, wave properties) from the Environment. Supports static and animated visualization including back-and-forth motion and continuous rotation.

Note: Requires FH_VISUALIZATION to be defined for rendering support.

Parameters

Name	Width	Description
ComputeFunction	1	Quantity shown on the flow plane. Values: "VelocityMagnitude" (default), "CurrentMagnitude", "Pressure", "TotalPressure", "WakeFactor", "SurfaceElevation".
Position	3	Initial plane centre in NED frame [x, y, z] [m]. (Default: 0, 0, 0)
LocalX	3	Initial local X axis direction (unit vector). (Default: 1, 0, 0)
LocalY	3	Initial local Y axis direction (unit vector). (Default: 0, 1, 0)
Position2	3	Second plane centre for back-and-forth motion [x, y, z] [m]. (Optional)
PositionPeriod	1	Period of the back-and-forth oscillation [s]. (Optional)
RotationPeriodX	1	Period of spin around localX axis [s]; 0 = no spin. (Optional)
RotationPeriodY	1	Period of spin around localY axis [s]; 0 = no spin. (Optional)
Size	2	Plane dimensions [u, v] [m]. (Default: 50, 50)
Vertices	2	Number of vertices for plane mesh [u, v]. (Default: 50, 50)
VisibleRange	2	Visible range [min, max] for flow quantity. (Default: 0, 20)
ColorRange	2	Color mapping range [min, max]. (Default: 0, 3)
AlphaRange	2	Alpha transparency range [min, max]. (Default: 0.2, 1.0)

This SimObject is referred to as VisualFlowPlane