STREAMLINE

Streamlines are massless particles moving along a path with a velocity tangent to the streamline at every point.

Syntax

STREAMLINE(“name”) {parameters}

Qualifier

User-given name

Parameters

name (string): User-given name of the command. The instance of a given command is referenced using this parameter.
dataset (string): Reference name as defined within the DATASET command. Used to indicate which dataset should be used to create the representation from.
seed_type (enum): Method of identifying seed locations; Options: rectangular, rake, from_file.
normal_direction (enum): Cartesian direction used to cut the volume data with specified plane cut_location; Options: x, y, z
calculation_direction (enum): Defines the calculation direction for the streamline calculation.; Options: forward (default), backward or both.
x_center (real): x-coordinate of centerpoint of rectangle. Used when seed_type=rectangular.
y_center (real): y-coordinate of centerpoint of rectangle. Used when seed_type=rectangular.
z_center (real): z-coordinate of centerpoint of rectangle. Used when seed_type=rectangular.
x_length (real): Length of rectangle in the x direction. Used when seed_type=rectangular.
y_length (real): Length of rectangle in the y direction. Used when seed_type=rectangular.
z_length (real): Length of rectangle in the z direction. Used when seed_type=rectangular.
x_seeds (integer): Number of seeds equally spaced along the rectangle in the x direction. Used when seed_type=rectangular.
y_seeds (integer): Number of seeds equally spaced along the rectangle in the y direction. Used when seed_type=rectangular.
z_seeds (integer): Number of seeds equally spaced along the rectangle in the z direction. Used when seed_type=rectangular.
x_1 (real): x location of first seed of rake. Used with seed_type = rake.
y_1 (real): y location of first seed of rake. Used with seed_type = rake.
z_1 (real): z location of first seed of rake. Used with seed_type = rake.
x_2 (real): x location of second seed of rake. Used with seed_type = rake.
y_2 (real): y location of second seed of rake. Used with seed_type = rake.
z_2 (real): z location of second seed of rake. Used with seed_type = rake.
num_seeds (integer): Number of seeds to place between two specified points for rake
seed_file (string): Absolute or relative path and file name to the seed file, defines the x, y, z locations of the seeds to be used for streamline generation. Used when seed_type=from_file.
color_type (enum): Method used to set the display color.; Options: constant, contour
constant_color (enum): Display the streamlines as a constant color; Options: white, green, blue, magenta, gray, yellow, light_blue, purple, red, black
contour_function (string): Scalar quantity to be displayed on the streamline (pressure, velocity, etc., see Calculate Context Help). Used with color_type=contour.
vector_function (string): Vector field to define the streamline computation (velocity, time_avg_velocity, velocity_xz, time_avg_velocity_xz)
line_thickness (enum): Thickness of lines for streamline display.
legend_display (boolean): Flag to toggle on or off the visibility of the legend
legend_min (real): Minimum value in legend
legend_max (real): Maximum value in legend
legend_location (enum): Location of the legend on the image; Options: lower_left, lower_right, lower_center, top_left, top_right, top_center
legend_use_local (enum): Boolean to control the local legend range. If active, will set for local entity range.
legend_title (string): Legend name to be used for the provided contour function, defaults to internal name.
colormap_name (enum): Colormap name to use for displaying the scalar function values; Options: Cool to Warm, Cool to Warm (Extended), Black-Body Radiation, X Ray, Inferno, Black, Blue and White, Blue Orange, Viridis, Gray and Red, Linear Green, Cold and Hot, Blue – Green – Orange, Rainbow Desaturated, Yellow – Gray – Blue, Rainbow Uniform, Rainbow, Rainbow Legacy

Example

STREAMLINE("upstream rake"){
dataset = “uFX_FullData”
calculation_direction = forward
seed_type = rake
normal_direction = x
x_1 = (xMax-xMin)*.2 + xMin
y_1 = yMax*.99
z_1 = (zMax-zMin)/2.0 + zMin
x_2 = (xMax-xMin)*.2 + xMin
y_2 = yMin*.99
z_2 = (zMax-zMin)/2.0 + zMin
num_seeds = nSeeds
line_thickness = thin
color_type = contour
contour_function = "velocity_magnitude"
legend_display = on 
vector_function = "velocity"
legend_use_local = off
legend_min = .6*meanVel
legend_max = 2.5*meanVel
legend_title = “Velocity Magnitude (m/s)”
}

IMAGE("Full vehicle streamlines"){
parts = {"Full vehicle - white"}
streamlines = {" upstream rake "}
image_type = static
views = {"front_left_top","rear_left_top","left","front_left_bottom","front_right_bottom"}
focal_parts = {"Full vehicle - white","Full vehicle - white","Full vehicle - white","Full vehicle - white","Full vehicle - white","Full vehicle - white","Full vehicle - white","Full vehicle - white","Full vehicle - white"}
zoom_factors= {1.2,1.2,1.5,1.2,1.2}
}

STREAMLINE("Vortex Core Streamlines"){
dataset = “uFX_FullData”
vector_function = "velocity"
calculation_direction = forward
display_seeds = off
seed_type = from_file
seed_file = "VC_Seeds.csv"
line_thickness = medium
color_type = contour
vector_function = "time_avg_velocity"
contour_function = "time_avg_velocity"
legend_display = on
legend_location = top_center
legend_orientation = horizontal
legend_min = 0
legend_max = meanVel
colormap_name = "Rainbow Desaturated
}


IMAGE("Vortex Core seeded streamlines"){
Parts = {"Full vehicle - white"}
streamlines = {"Vortex Core Streamlines"}
image_type = static
views = {"front","front_left_top","rear_left_top","rear","top","left","bottom","front_left_bottom","front_right_bottom"}
focal_parts = {"Full vehicle - white","Full vehicle - white","Full vehicle - white","Full vehicle - white","Full vehicle - white","Full vehicle - white","Full vehicle - white","Full vehicle - white","Full vehicle - white"}
zoom_factors = {2.0,1.2,1.2,2.0,1.5,1.5,1.5,1.2,1.2}
}