CUT_PLANE
Visualization surface along x, y or z.
Syntax
CUT_PLANE(“name”) { parameters}
Qualifier
User-given name
Parameters
- normal_direction (enum)
- Cartesian direction used to cut the volume data with specified plane cut_location
- 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
- 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
- transparency (real)
- Level of transparency
- constant_color (enum)
- Color to use for the display of the cut plane. Used with color_type=constant.
- 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.
- contour_line_display (boolean)
- Display lines on the contour
- contour_line_display_type (enum)
- Line display type of contour lines
- num_contours (integer)
- Number of contour lines to be displayed when display_type=contour_lines
- 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
- color_type (enum)
- Method used to set the display color
- 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
- legend_location (enum)
- Location of the legend on the image
- 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
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
threshold_function = "x-velocity"
threshold_min = .8
threshold_max = 1000
}
CUT_PLANE("CpT Cut Plane X"){
normal_direction = x
cut_location = 0
y_min = -0.75
y_max = 0.75
z_min = -0.6
z_max = 0.8
display_type = solid
color_type = contour
contour_function = time_avg_total_pressure_coefficient
colormap_name = "Cool to Warm (Extended)"
legend_display = on
legend_min = -1
legend_max = 1
legend_location = bottom_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
}