Streakline

DESCRIPTION

This module calculates a streakline through a velocity field. It stops when either the new velocity is 0, or when the streak intersects the bounds of the velocity field.

The X,Y,Z dials are hidden by default. They can either be wired or the user can change the hidden status of the widgets in the mbuilder if access is desired. The new input is a pick structure which can be generated by the Render module.

INPUTS

Port: Flow Field
Type: Lattice
Constraints: 2..3-D
Constraints: 3..-vector
Constraints: float
Velocity field. The first 3 data variables are the velocity.

Port: Start Point
Type: Pick
Optional: This port is optional.
This is the starting point for the streakline.

WIDGETS

Port: Status
Type: Option Menu
Menu Item: Incremental
Menu Item: Completed
Menu Item: Terminate
Menu Item: Clear
Menu for choosing run mode. Choices are : show each iteration, show when the solution is complete, stop (if in iteration mode), and clear the graphics output of all the streaklines.

Port: X
Type: Dial
Input index into the velocity field in the X direction for the starting point.

Port: Y
Type: Dial
Input index into the velocity field in the Y direction for the starting point.

Port: Z
Type: Dial
Input index into the velocity field in the Z direction for the starting point.

Port: Start mode
Type: Button

Port: tolerance
Type: Dial
The relative tolerance used for adapting the time step convergence.

OUTPUTS

Port: Particle Path
Type: Geometry
This is the geometry for all the paths. The current path is in red and the old paths are in green.

KNOWN PROBLEMS

There is no maximum number of iterations. If the path intersects itself the module may never exit. If the mode is to show solution when complete, the module may need to be killed externally.

SEE ALSO

Render.
[Documentation Home]
© The Numerical Algorithms Group Ltd, Oxford UK. 2000