CUT_PLANE

Visualization surface along x, y or z.

Syntax

CUT_PLANE(“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.
normal_direction (enum)
Cartesian direction used to cut the volume data with specified plane cut_location
Options: x, y, z
cut_location (real)
Location of cut along the specified normal direction
x_min (real)
Minimum extent of the plane in x
x_max (real)
Maximum extent of the plane in x
y_min (real)
Minimum extent of the plane in y
y_max (real)
Maximum extent of the plane in y
z_min (real)
Minimum extent of the plane in z
z_max (real)
Maximum extent of the plane in z
display_type (enum)
Specify how to display the surface
Options: solid, mesh_lines, feature_lines, contour_lines, vectors
transparency (real)
Level of transparency
1 is fully transparent
color_type (enum)
Method used to set the display color
constant_color (enum)
Color to use for the display of the cut plane. Used with color_type=constant.
Options: white, green, blue, magenta, gray, yellow, light_blue, purple, red, black
contour_function (string)
Scalar quantity to be displayed on part (pressure, velocity, etc., see Calculate Context Help). Used with color_type=contour.
line_thickness (enum)
Thickness of lines for mesh display, feature line display and contour_line display type.
Options: thin, medium, thick
num_contours (integer)
Number of contour lines to be displayed when display_type=contour_lines
The limit is 500 contours.
contour_line_min (real)
Minimum value of the contour line range, when display_type=contour_lines
contour_line_max (real)
Maximum value of the contour line range, when display_type=contour_lines
contour_colormap_style (enum)
Type of contour coloring style, when color_type=contour.
Options: continuous (default) or filled
contour_color_numbers (integer)
Number of discrete contour colors, when color_type=contour and contour_colormap_style=filled.
The default value is 12.
vector_subset (boolean)
Method used to subset the vectors displayed on the cut_plane, when display_type=vectors
vector_subset_percentage (integer)
Percentage of vectors to use, when display_type=vectors and vector_subset=on
vector_scale_factor (real)
Factor to scale vector tails by, when display_type=vectors
vector_length_type (enum)
Type of vector length scaling, when display_type=vectors
Options: magnitude, uniform
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_orientation (enum)
Specify orientation of the legend
Options: horizontal, vertical
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
threshold_clipping (boolean)
Specify if the cut plane should be clipped by the specified threshold
threshold_function (string)
Function to be used as threshold
threshold_min (real)
Minimum threshold value
threshold_max (real)
Maximum threshold value
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

CUT_PLANE("z cut"){
     normal_direction          = z
     cut_location              = 0.0
     display_type              = solid
     color_type                = contour
     contour_function          = "x-velocity"
     constant_color            = black
     legend_display            = on
     legend_use_local          = on
     legend_min                = -100
     legend_max                = 100
     legend_title 		= “X-Velocity (m/s)”
     threshold_clipping        = off
}
CUT_PLANE("CpT Cut Plane X"){
normal_direction = x
cut_location =(xMax-xMin)/2.0
y_min = yMin_xSlice
y_max = yMax_xSlice
z_min = zMin_xSlice
z_max = zMax_xSlice
display_type = solid
color_type = contour
contour_function = time_avg_total_pressure_coefficient
colormap_name = "Cool to Warm (Extended)"
legend_display = on
legend_min = minCp_medium
legend_max = maxCp_medium
legend_location = lower_center
legend_orientation = horizontal
legend_use_local = off
threshold_clipping = on
threshold_function = time_avg_total_pressure_coefficient
threshold_min = -1
threshold_max = 0.98
}
CUT_PLANE("CpT Cut Plane X - Contours"){
normal_direction = x
cut_location = 0
y_min = -0.75
y_max = 0.75
z_min = -0.6
z_max = 0.8
legend_min = -1
legend_max = 1
display_type = contour_lines
color_type = constant
constant_color = black
contour_function = time_avg_total_pressure_coefficient
colormap_name = "Cool to Warm (Extended)"
line_thickness = thin
num_contours = 10
contour_line_min = -1
contour_line_max = 1
}
IMAGE("X normal - time_avg_velocity_mag"){
parts = {"RW - Grey - Transparent"}
cut_planes = {"CpT Cut Plane X","CpT Cut Plane X -
Contours"}
views = {"front"}
image_type = cut_plane_sweep
sweep_planes = {"CpT Cut Plane X","CpT Cut Plane X -
Contours"}
sweep_type = direct
sweep_range = xMin:xMax:(xMax-xMin)/nCutPlanes
focal_parts = {"RW - Grey - Transparent"}
clip_parts = off
reverse_clip_direction = off
}
CUT_PLANE("Full Vehicle X normal - velocity_coefficient Non-Continuous"){
 normal_direction = x
 cut_location = (xMax-xMin)/2.0
 display_type = solid
 color_type = contour
 contour_function = "time_avg_velocity_magnitude_coefficient"
 legend_display = on
 legend_min = 0.0
 legend_max = 1.3
 legend_location = top_center
 legend_orientation = horizontal
 y_min = yMin_xSlice
 y_max = yMax_xSlice
 z_min = zMin_xSlice
 z_max = zMax_xSlice
 colormap_name = "Rainbow Desaturated"
 contour_colormap_style = filled
 contour_color_numbers = contourColors
}
IMAGE("Full Vehicle X normal Detailed Front Fender - velocity_coefficient Non-Continuous"){
Parts = {"Full vehicle - white"}
cut_planes = {"Full Vehicle X normal - velocity_coefficient Non-Continuous"}
sweep_planes = {"Full Vehicle X normal - velocity_coefficient Non-Continuous"}
image_type = cut_plane_sweep
sweep_range_type = direct
sweep_range = xStart_fr:xEnd_fr:xSpacing_detailed
views = {"front"}
focal_parts = {"Front Left Fender"}
zoom_factors = {1.3}
clip_parts = on
reverse_clip_direction = off
image_savetype = movie
}
CUT_PLANE("Full Vehicle X normal - velocity_coefficient Vectors"){
normal_direction = x
cut_location = (xMax-xMin)/2.0
display_type = vectors
contour_function = time_avg_velocity_magnitude_coefficient
vector_function = "time_avg_velocity_yz" 
color_type = constant
constant_color = black
y_min = yMin_xSlice
y_max = yMax_xSlice
z_min = zMin_xSlice
z_max = zMax_xSlice
vector_subset = on
vector_subset_percentage = 50
vector_scale_factor = 0.004
vector_length_type = uniform
}
IMAGE("Full Vehicle X normal - Velocity Coefficient Vectors"){
parts = {"Full vehicle - white"}
cut_planes = {"Full Vehicle X normal - velocity_coefficient","Full Vehicle X normal - velocity_coefficient Vectors"}
views = {"front"}
sweep_planes = {"Full Vehicle X normal - velocity_coefficient","Full Vehicle X normal - velocity_coefficient Vectors"}
image_type = cut_plane_sweep
sweep_range_type = direct
sweep_range = xStart:xEnd:xSpacing
focal_parts = {"Full vehicle - white"}
zoom_factors = {3.5}
clip_parts = off
reverse_clip_direction = off
image_savetype = movie
}