Go to www.awrcorp.com
Back to search page Click to download printable version of this guide.
Streamline

Description

Streamlines represent the path that a massless particle would take in a vector field. In other words, a streamline is a line that is everywhere tangent to the vector field.

Annotation Types

Field

Parameters

Label - A unique name that identifies the filter. (IFilter/Label)

Enabled - If false, filter is excluded from filter chain. (IFilter/Enabled)

Source Plane/Point - [LENGTH] - A point on the line or plane from which to launch the streamlines. Defined in the world coordinate system. (IStreamLineFilter/Origin)

Source Plane/Normal - Vector normal to the line or plane from which to launch the streamlines. Defined in the world coordinate system. This is a unitless vector and its magnitude is irrelevant. (IStreamLine/Normal)

Source Plane/Project To Outside Of Mesh - If true the Source Plane/Point value is overridden to ensure that the streamlines are launched from outside the mesh. This guarantees maximum travel. (IStreamLine/OnSurface)

Resolution/Major - Number of launches in the major direction. The major direction is defined as the longer direction of the result of cutting the bounding box of the field using the specified line or plane. (IStreamLineFilter/MajorResolution)

Resolution/Minor - Number of launches in the minor direction. The minor direction is defined as the shorter direction of the result of cutting the bounding box of the field using the specified plane. Has no effect in for fields on 2D meshes. (IStreamLineFilter/MinorResolution)

Example(s)

Field to be filtered:

Project To Outside Of Mesh: True

Project To Outside Of Mesh: False

User Interface Button

Requirements

Only valid for vector fields.

Example Script

PyViewConfig_1.Get_IView3DConfig().RemoveIsolated((PyFieldAnnotation_1.Get_IIsolatable())) PyStreamLineFilter_1 = PyConfig_1.Get_IAnnotationConfig().NewFilter("StreamLineFilter", "Streamline_1")

Scripting Interfaces

“IStreamLineFilter”
“IFilter”

Please send email to awr.support@ni.com if you would like to provide feedback on this article. Please make sure to include the article link in the email.

Legal and Trademark Notice