CUT_PLANE

Visualization surface along x, y or z.

Syntax

CUT_PLANE(“name”) { parameters}

Qualifier

User-given name

Parameters

normal_direction (enum)
Used when seed_type=rectangular
Options: x, y, z
cut_location (real)
Location of cut along the specified axis
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
name (string)
User-given name of the command. The instance of a given command is referenced using this parameter.
display_type (enum)
Specify how to display the surface
Options: solid, mesh_lines, feature_lines, contour_lines, vectors, vertices, shaded_vertices
solid_display_type (enum)
Specify the shading type for the surface. Used with display_type=solid
Options: flat, faceted, smooth
mesh_line_display (boolean)
Flag to control display of the mesh lines
Options: thin, medium, thick
transparency (real)
Level of transparency
1 is fully transparent
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 cut plane (pressure, velocity, and so on). Used with color_type=contour.
line_thickness (enum)
Thickness of lines for mesh display and feature line display
Options: thin, medium, thick
contour_line_display (boolean)
Display lines on the contour
contour_line_display_type (enum)
Line display type of contour lines
Options: black, white, contour, constant
num_contours (integer)
Number of contour lines to be displayed in legend
The limit is 500 contours.
color_type (enum)
Method used to set the display color
Options: constant, contour
active_flag (boolean)
Read and process the command or ignore it
legend_display (boolean)
Flag to toggle on or off the visibility of the legend
num_labels (integer)
Number of labels used in 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: top_left, top_center, top_right, bottom_left, bottom_center, bottom_right, center_left, center_right
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
log_scale (boolean)
When selected, the scalar will be colored using a logarithmic scale instead of a standard scale.
Can be used on all colormaps.

Example

CUT_PLANE("z cut"){
     normal_direction          = z
     cut_location              = 0.0
     display_type              = solid
     solid_display_type        = smooth
     color_type                = contour
     contour_function          = "x-velocity"
     contour_line_display      = off
     contour_line_display_type = "constant"
     mesh_line_display         = off
     constant_color            = black
     line_thickness            = medium
     legend_display            = on
     legend_use_local          = on
     legend_min                = -100
     legend_max                = 100
     num_labels                = 5
     num_decimal_places        = 5
     threshold_clipping        = off
     threshold_function        = "x-velocity"
     threshold_min             = .8
     threshold_max             = 1000
}