SURFACE_STREAMLINE

Surface streamlines are massless particles moving along the surface of an object or plane with a velocity tangent to the streamline at every point.

Syntax

SURFACE_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)
Defines the type of seeding operation
Options: from_surface, from_file.
surface_type (enum)
The type of surface that the surface_streamlines will be defined on. Note that the Part or Cut_Plane that the surface streamlines are drawn on must be created, using the Image command.
Options: parts (default), cut_planes.
cut_planes (list)
Cut planes to seed, used when surface_type=cut_planes.
List provided as comma separated values within curly braces. {“cut_plane_1”, “cut_plane_2”}
parts (list)
Parts to seed, used when surface_type=parts.
List provided as comma separated values within curly braces. {“part_1”, “part_2”}
calculation_direction (enum)
Defines the calculation direction for the streamline calculation.
Options: forward (default), backward or both.
num_seeds
(integer) Number of seeds to use when seeding the surface streamlines
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.
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
Options: thin, medium, thick
contour_function (string)
Scalar quantity to be displayed on part (pressure, velocity, etc., Calculate Context Help). Used with color_type=contour.
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: top_left, top_center, top_right, bottom_left, bottom_center, bottom_right, center_left, center_right
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

SURFACE_STREAMLINE("Full Vehicle Surface Streamlines"){
dataset = “uFX_SurfaceData”
seed_type = from_surface
surface_type = parts
parts = {"Full vehicle - white"}
num_seeds = 6000
vector_function = "time_avg_wall_shear_stress"
calculation_direction = both
color_type = contour
contour_function "time_avg_skin_friction_coefficient"
colormap_name = "Inferno"
legend_display = on
legend_title = "Cf (time-averaged)"
legend_min = cf_min
legend_max = cf_max
legend_location = top_center
legend_orientation = horizontal
}
SURFACE_STREAMLINE("Y-Slice Time Average Cv - Surface Streamlines"){
dataset = “uFX_SurfaceData”
seed_type = from_surface
surface_type = cut_planes
num_seeds = 600
vector_function = "time_avg_velocity" 
cut_planes = {"Y-Slice Time Average Cv - Contour"}
calculation_direction = both
color_type = constant
constant_color = "black"
}
IMAGE("Y-Slice Time Average Cv - Streamlines"){
parts = {"Full vehicle - white - 0.5 transparent"}
cut_planes = {"Y-Slice Time Average Cv - Contour"}
surface_streamlines = {"Y-Slice Time Average Cv - Surface Streamlines"}
views = {"right"}
focal_parts = {"Full vehicle - white - 0.5 transparent"}
zoom_factors = {y_slice_zoom_factor}
sweep_planes = {"Y-Slice Time Average Cv - Contour"}
image_type = cut_plane_sweep
sweep_range_type = direct
sweep_range = yStart:yEnd:ySpacing
image_savetype = images
clip_parts = on
reverse_clip_direction = on
}