Streamline

Synopsis

Constructs streamlines based on node vector data

Input Port

in_field	Mesh + Node_Data
ui_parent	user interface parent object

Parameters

Probe on/offf	UItoggle	displays a probe
start point	UIradioBoxLabel	selects the type of the probe
x-dimension	UIslider	sets the sampling probe frequency in the x direction
y-dimension	UIslider	sets the sampling probe frequency in the y direction
Transfomration Editor	UItoggle	displays the transformation editor for the probe
velocity vector	UIradioBoxLabel	selects a component of node data
Direction	UIradioBoxLabel	forward/backward motion
nsegments	UIslider	accuracy of integration
max segments	UIslider	total number of integration steps
order	UIslider	order of integration
min velocity	UIslider	minimum velocity value when integration stops
Color	UItoggle	sets the color of the streamlines
Ribbons	UItoggle	create streamribbons
ribbon width	UIslider	control width of ribbon
ribbon angle	UIslider	set ribbon angle

Output Port

out_stream_obj	output renderable object correponding to the streamline
out_probe_obj	output renderable object correponding to the probe

Description

Streamline constructs streamlines by integrating the vector data at the node. A ribbon display is possible.

The arrangement of the starting points of streamlines can be of three types: point, line and plane. Their positions can be changed using the Transform editor.

Input

in_field

The input is a field with 3 elements for each vector data.

ui_parent

A port to connect to a user interface object that contains the macro's widgets. By default, it is connected to the default user interface object in the application in which the macro is instanced. (This default connection is not drawn.)

Parameters

Probe on/off

UItoggle. If this parameter is turned on, the probe (the starting points of streamlines) is displayed.

start point

UIradioBoxLabel. Selects the probe type which can be either one of point, line or plane.

x-dimension

UIslider. This parameter is only valid when the probe type is either line or plane. X-dimension sets the sampling frequency of probes (number of starting points) in the x direction. However, in the case of line, this becomes the number of points in the line.

y-dimension

UIslider. This parameter is only valid when the probe type is plane. Y-dimension sets the sampling frequency of probes (number of starting points) in the y direction.

Transformation Editor

UItoggle. When this parameter is turned on, the tranformation editor for the probe is displayed. It is possible to rotate, translate and scale the probe using this editor. In addition, the probe can be transformed using the mouse after selecting the probe object i.e. without using this editor.

velocity vector

UIradioBoxLabel. Radio buttons to pick on which component to base the streamlines. The selection must be a three-element vector.

Direction

UIradioBoxLabel. Radio buttons to pick the direction of streamline generation, forward or backward. The default is forward.

nsegments

UIslider. An integer slider that sets how many integration steps will be used within one grid "cell" to compute the streamline path. The default is 2. The range is from 0 to 16.

max segments

UIslider. An integer slider that sets the total number of integration steps. When an individual streamline exceeds this value, integration for it stops. The range is from 1 to 10000. The default is 256.

order

UIslider. An integer slider that sets the order of integration. Higher orders are more accurate, but execute more slowly. The default is 2. The range is from 1 to 4.

min velocity

UIslider. A float slider. When a streamline falls below this velocity, the integration process for that streamline stops. The default is 0.00001. The range is from 0.0 to unbounded. You can use this to prevent wasted computation for streamlines barely moving, or even stationary (min_velocity = 0).

Color

UItoggle. When this parameter is turned on, the streamlines are colored based on the magnitude of the vector data. When this parameter is off, the lines are drawn in white.

Ribbons

UItoggle. When on, streamlines produce streamribbons rather than streamlines. The default is off.

ribbon width

UIslider. An integer slider. Scales the width of the ribbon. Ribbon width varies along its length according to the divergence of the flow. This value controls ribbon width at the beginning of the ribbon. The default is 1. The range is unbounded.

ribbon angle

UIslider. An integer slider. Controls the initial angle at which the ribbon is drawn. The default is 0. The range is 0.0 to 360.0.

Output Port

out_stream_obj

A renderable object corresponding to the stremline.

out_probe_obj

A renderable object corresponding to the probe.

Example

Not available

File

v/modules.v

See also related modules

Not applicable.