Particle_Advector

Synopsis

Advects particles with no mass based on the vector data at a node

Input Port

in_field	Mesh + Node_Data
ui_parent	user interface parent object

Parameters

Probe on/offf	UItoggle	displays a probe
Probe parameter	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
Glyph parameter	UIradioBoxLabel	sets the type of the glyph
Sphere Subdivision	UIslider	number of subdivisions of the sphere
Base Subdivision	UIslider	number of subdivisions of the arrow-head
Streamline on/off	UItoggle	displays streamlines
N-segments	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
Direction	UIradioBoxLabel	forward/backward motion of particles
Mode	UIradioBoxLabel	render glyphs to represent data values
Glyph Normalize	UItoggle	normalizes glyph size
Glyph Scale	UIslider	scale factor for glyph
Start Time	UIslider	start of advection
End Time	UIslider	end of advection
Step	UIslider	integration step
Time	UIfieldTypein	current time value
Run	UItoggle	press to start/stop advection
Reset Time	UItoggle	reset time to Start Time
Cycle	UItoggle	on End Time, continue with Start Time

Output Port

out_probe_obj	output renderable object correponding to the probe
out_stream_obj	output renderable object correponding to the streamline
out_glyph_obj	output renderable object corresponding to the glyph

Description

Particle_Advector advects particles with no mass depending on the vector data at a node and animates them. If the vector data denote velocity then it is possible to simulate flow using this module.

The arrangement of the starting points of particles can be of three types: point, line and plane. Their positions can be changed using the Transform editor. The shape of the particle can set using the Glyph parameter.

Advection starts when you turn the Run toggle on. Advection for individual particles stops when one of the following conditions occurs:

A particle exceeds the Max Segments value.

The particle's velocity drops below the Min Velocity.

The particle goes outside the field's bounds.

Advection of all particles stops when one of the following two conditionsoccurs:

The End Time value is reached.

You turn the Run toggle off.

Input

in_field

The input is a field with 3 elements for each vector data. If the node has multiple components, the first component is selected. Use the extract component module to extract the necessary component if any other component is to be used.

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 point of particles) is displayed.

Probe parameter

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.

Glyph parameter

UIradioBoxLabel. Selects the glyph type to be used as particle. The following types are available: Sphere, Diamond, Arrow1, Arrow2, Arrow3, Arrow4 and Jet.

Sphere Subdivisions

UIslider.Sets the number of subdivisions of the sphere. The larger the number of subdivisions, the smoother the sphere and the higher the load on the machine.

Base Subdivisions

UIslider. Sets the number of subdivisions of the arrow-head. The larger the number of subdivisions, the more closely the arrow-head approximates a cone. However, the load on the machine is higher in this case.

Streamline on/off

UItoggle. If this parameter is turned on, streamlines are displayed.

Refer to the advect module for a description of other parameters.

Output Port

out_probe_obj

A renderable object corresponding to the probe.

out_stream_obj

A renderable object corresponding to the stremline.

out_glyph_obj

A renderable object corresponding to the glyph.

Example

Not available

File

v/modules.v

See also related modules

Not applicable.