Synopsis
create streamlines and stream ribbons for a Multi_Block object
Input Ports
|
in_field |
Multi_Block |
|
in_probe |
Plane_Mesh |
|
parent |
UIconnection |
Output Ports
|
out_fld |
Mesh+Cell_Data |
|
out_obj |
output renderable object |
Description
stream_multi_block creates streamlines and stream ribbons for a Multi_Block object.
Input Ports
multi_block
Multi_Block. The input multiblock dataset.
in_probe
Plane_Mesh. Streamlines start at each node of this mesh.
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.
Parameters
Direction
UIradioBoxLabel. When on (nonzero), streamlines are advected forward, in the downstream direction of the flow. When off (zero), they are advected backward, upstream in the flow. The default is forward.
nsegments
UIslider. The number of integration steps used per grid cell to compute the streamline path. The default is 2.
max segments
UIslider. Maximum number of integration steps to take for an individual streamline. A streamline is terminated either when it leaves the dataset, when the absolute value of its velocity is less than the min_velocity parameter, or when it exceeds this number of integration steps.
order
UIslider. Integration order for the streamline advection. Higher orders are more accurate but execute more slowly. The default is 2, for second-order integration. The range is from 1 to 4.
min_velocity
UIslider. If the absolute value of the velocity is less than this limit, the streamline advection is terminated. This is usually used to avoid wasting computation on streamlines which are barely moving. Velocity is measured in the coordinate system of the dataset. The default is 0.000001.
Color
UItoggle. When on (nonzero), color the streamlines by velocity. When off (zero), do not color the streamlines. Default is on.
Ribbons
UItoggle. When on (nonzero), stream_multi_block produces stream ribbons rather than streamlines. The width of the ribbons varies along the length with the divergence of the field, and the angle varies with the curl.
ribbon width
UIslider. This value scales the width of the ribbons when Ribbons are turned on.
ribbon angle
UIslider. This value sets the initial angle at which the ribbons are drawn. The ribbons twist along their length according to the curl of the field.
Output Ports
out_fld
Mesh+Node_Data. Field containing the streamlines.
out_obj
Renderable object corresponding to out_fld.
Example
Libraries.Examples.Visualization.Multi_Block
examples/mblock.v
File
v/modules.v
See also