display

class ansys.fluent.core.meshing.tui_232.main_menu.display(path, service)

Bases: TUIMenu

Enter the display menu.

Classes:

advanced_rendering(path, service)	Enter the advanced rendering menu.
display_states(path, service)	Enter the display states menu.
objects(path, service)	Contains commands for displaying objects.
set(path, service)	Enables you to enter the set menu to set the display parameters.
set_grid(path, service)	Contains options controlling the display of the grid.
update_scene(path, service)	Contains commands that enable you to update the scene description.
xy_plot(path, service)	Enters the XY plot menu.
zones(path, service)	Contains commands for displaying zones.

Methods:

all_grid(*args, **kwargs)	Displays the grid according to the currently set parameters.
annotate(*args, **kwargs)	Adds annotation text to a graphics window.
boundary_cells(*args, **kwargs)	Displays boundary cells attached to the specified face zones.
boundary_grid(*args, **kwargs)	Displays only boundary zones according to the currently set parameters.
center_view_on(*args, **kwargs)	Sets the camera target to be the center (centroid) of an entity.
clear(*args, **kwargs)	Clears the active graphics window.
clear_annotation(*args, **kwargs)	Removes all annotations and attachment lines from the active graphics window.
draw_cells_using_faces(*args, **kwargs)	Draws cells that are neighbors for the selected faces.
draw_cells_using_nodes(*args, **kwargs)	Draws cells that are connected to the selected nodes.
draw_face_zones_using_entities(*args, **kwargs)	Draws cells that are connected to the selected entities.
draw_zones(*args, **kwargs)	Draws the boundary/cell zones using the zone ID specified as input.
redisplay(*args, **kwargs)	Redraws the grid in the graphics window.
save_picture(*args, **kwargs)	Saves a picture file of the active graphics window.
set_list_tree_separator(*args, **kwargs)	Sets the separator character to be used to determine the common prefix for items listed in the selection lists, when the tree view is used.
show_hide_clipping_plane_triad(*args, **kwargs)
update_layout(*args, **kwargs)	Update the fluent layout.
views(*args, **kwargs)	Enters the view window options menu.

class advanced_rendering(path, service)

Bases: TUIMenu

Enter the advanced rendering menu.

Methods:

edge_color(*args, **kwargs)	Choose between black and body colored edges.
fast_silhouette_edges(*args, **kwargs)	Enhances viewability by adding fast silhouette edges.
max_extent_culling(*args, **kwargs)	Truncates zones smaller that the maximum extent culling pixel value.
simple_shadow(*args, **kwargs)	Enhances viewability by adding a simple shadow.
static_model(*args, **kwargs)	Static model driver setting.

edge_color(*args, **kwargs)

Choose between black and body colored edges.

fast_silhouette_edges(*args, **kwargs)

Enhances viewability by adding fast silhouette edges.

max_extent_culling(*args, **kwargs)

Truncates zones smaller that the maximum extent culling pixel value.

simple_shadow(*args, **kwargs)

Enhances viewability by adding a simple shadow.

static_model(*args, **kwargs)

Static model driver setting.

all_grid(*args, **kwargs)

Displays the grid according to the currently set parameters.

annotate(*args, **kwargs)

Adds annotation text to a graphics window. It will prompt you for a string to use as the annotation text, and then a dialog box will prompt you to select a screen location using the mouse-probe button on your mouse.

boundary_cells(*args, **kwargs)

Displays boundary cells attached to the specified face zones.

boundary_grid(*args, **kwargs)

Displays only boundary zones according to the currently set parameters.

center_view_on(*args, **kwargs)

Sets the camera target to be the center (centroid) of an entity.

clear(*args, **kwargs)

Clears the active graphics window. This option is useful when you redo an overlay.

clear_annotation(*args, **kwargs)

Removes all annotations and attachment lines from the active graphics window.

class display_states(path, service)

Bases: TUIMenu

Enter the display states menu.

Methods:

apply(*args, **kwargs)	Apply a display state to the active graphics window.
copy(*args, **kwargs)	Copy the settings of an existing display state to another existing display state.
create(*args, **kwargs)	Create a new display state.
delete(*args, **kwargs)	Delete a display state.
edit(*args, **kwargs)	Edit a display state.
list(*args, **kwargs)	Print the names of the existing display states to the console.
read(*args, **kwargs)	Read in display states from a file.
use_active(*args, **kwargs)	Save the display state settings of the active graphics window to an existing display state.
write(*args, **kwargs)	Write one or more of the saved display states to a file.

apply(*args, **kwargs)

Apply a display state to the active graphics window.

copy(*args, **kwargs)

Copy the settings of an existing display state to another existing display state.

create(*args, **kwargs)

Create a new display state.

delete(*args, **kwargs)

Delete a display state.

edit(*args, **kwargs)

Edit a display state. Enter quit (or a substring, such as q or qui) to exit the editing loop.

list(*args, **kwargs)

Print the names of the existing display states to the console.

read(*args, **kwargs)

Read in display states from a file.

use_active(*args, **kwargs)

Save the display state settings of the active graphics window to an existing display state. This command is not available when the active window is displaying a 2D plot.

write(*args, **kwargs)

Write one or more of the saved display states to a file.

draw_cells_using_faces(*args, **kwargs)

Draws cells that are neighbors for the selected faces.

draw_cells_using_nodes(*args, **kwargs)

Draws cells that are connected to the selected nodes.

draw_face_zones_using_entities(*args, **kwargs)

Draws cells that are connected to the selected entities.

draw_zones(*args, **kwargs)

Draws the boundary/cell zones using the zone ID specified as input.

class objects(path, service)

Bases: TUIMenu

Contains commands for displaying objects.

Methods:

display_neighborhood(*args, **kwargs)	Displays the objects that are in the neighborhood of the selected object.
display_similar_area(*args, **kwargs)	Displays the objects with similar area to the selected object area.
explode(*args, **kwargs)	Explodes the objects in the geometry.
hide_objects(*args, **kwargs)	Hides the selected objects in the display.
implode(*args, **kwargs)	Implodes or assembles the objects in the geometry.
isolate_objects(*args, **kwargs)	Displays only the selected objects.
make_transparent(*args, **kwargs)	Makes the geometry transparent so that internal objects are visible.
select_all_visible(*args, **kwargs)	Selects all the visible objects in the graphics window.
show_all(*args, **kwargs)	Unhides all the objects in the geometry and displays them.
toggle_color_mode(*args, **kwargs)	Toggles the colors of the geometry.
toggle_color_palette(*args, **kwargs)	Toggles the color palette of the geometry.

display_neighborhood(*args, **kwargs)

Displays the objects that are in the neighborhood of the selected object. The neighboring objects have to be in contact, or intersecting the selected object.

display_similar_area(*args, **kwargs)

Displays the objects with similar area to the selected object area.

explode(*args, **kwargs)

Explodes the objects in the geometry. (This command is valid only when the geometry is an assembled mode.).

hide_objects(*args, **kwargs)

Hides the selected objects in the display.

implode(*args, **kwargs)

Implodes or assembles the objects in the geometry. (This command is available only when the geometry is an exploded mode.).

isolate_objects(*args, **kwargs)

Displays only the selected objects.

make_transparent(*args, **kwargs)

Makes the geometry transparent so that internal objects are visible. This command works as a toggle undoing the transparency of the previously selected objects.

select_all_visible(*args, **kwargs)

Selects all the visible objects in the graphics window.

show_all(*args, **kwargs)

Unhides all the objects in the geometry and displays them.

toggle_color_mode(*args, **kwargs)

Toggles the colors of the geometry. In one mode geometry is colored object-wise while in the other mode it is colored zone-wise.

toggle_color_palette(*args, **kwargs)

Toggles the color palette of the geometry.

redisplay(*args, **kwargs)

Redraws the grid in the graphics window.

save_picture(*args, **kwargs)

Saves a picture file of the active graphics window.

class set(path, service)

Bases: TUIMenu

Enables you to enter the set menu to set the display parameters.

Classes:

colors(path, service)	Enables you to enter the colors options menu.
lights(path, service)	Enters the lights menu.
picture(path, service)	Saves a hardcopy file of the active graphics window.
rendering_options(path, service)	Contains the commands that enable you to set options that determine how the scene is rendered.
styles(path, service)	Contains commands for setting the display style for the different types of nodes and faces that can be displayed.

Methods:

edges(*args, **kwargs)	Enables/disables the display of face/cell edges.
filled_grid(*args, **kwargs)	Enables/disables the filled grid option.
highlight_tree_selection(*args, **kwargs)	Turn on/off outline display of tree selection in graphics window.
line_weight(*args, **kwargs)	Sets the line width factor for the window.
native_display_defaults(*args, **kwargs)	Resets graphics window parameters to optimal settings for a local display.
overlays(*args, **kwargs)	Turns overlays on and off.
quick_moves_algorithm(*args, **kwargs)	Select quick moves algorithm for icons and helptext overlay.
re_render(*args, **kwargs)	Re-renders the current window after modifying the variables in the set menu.
remote_display_defaults(*args, **kwargs)	Adjusts graphics window parameters to optimal settings for a remote display.
reset_graphics(*args, **kwargs)	Resets the graphics system.
shrink_factor(*args, **kwargs)	Sets shrinkage of both faces and cells.
title(*args, **kwargs)	Sets the problem title.
windows(*args, **kwargs)	Enters the windows options menu, which contains commands that enable you to customize the relative positions of sub-windows inside the active graphics window.

class colors(path, service)

Bases: TUIMenu

Enables you to enter the colors options menu.

Methods:

automatic_skip(*args, **kwargs)	Specify whether the number of colormap labels is determined automatically.
axis_faces(*args, **kwargs)	Sets the color of axisymmetric faces.
background(*args, **kwargs)	Sets the background (window) color.
color_by_type(*args, **kwargs)	Enables you to specify that the entities should be colored by their type or ID.
far_field_faces(*args, **kwargs)	Sets the color of far field faces.
foreground(*args, **kwargs)	Sets the foreground (text and window frame) color.
free_surface_faces(*args, **kwargs)	Sets the color of free surface faces.
graphics_color_theme(*args, **kwargs)	Sets the color theme for the graphics window.
grid_inlet(*args, **kwargs)	Set the color of inlet faces.
grid_interior(*args, **kwargs)	Set the color of interior faces.
highlight_color(*args, **kwargs)	Sets the highlight color.
inlet_faces(*args, **kwargs)	Sets the color of the inlet faces.
interface_faces(*args, **kwargs)	Sets the color of grid interface faces.
interior_faces(*args, **kwargs)	Sets the color of the interior faces.
internal_faces(*args, **kwargs)	Sets the color of the internal interface faces.
list(*args, **kwargs)	Lists the colors available for the selected zone type.
outlet_faces(*args, **kwargs)	Sets the color of the outlet faces.
overset_faces(*args, **kwargs)	Sets the color of the overset faces.
periodic_faces(*args, **kwargs)	Sets the color of periodic faces.
rans_les_interface_faces(*args, **kwargs)	Sets the color of RANS/LES interface faces.
reset_colors(*args, **kwargs)	Resets the individual grid surface colors to the defaults.
reset_user_colors(*args, **kwargs)	Resets individual grid surface colors to the defaults.
show_user_colors(*args, **kwargs)	Lists the current defined user colors.
skip_label(*args, **kwargs)	Sets the number of labels to be skipped in the colormap scale.
surface(*args, **kwargs)	Sets the color of surfaces.
symmetry_faces(*args, **kwargs)	Sets the color of symmetric faces.
traction_faces(*args, **kwargs)	Sets the color for traction faces.
user_color(*args, **kwargs)	Enables you to change the color for the specified zone.
wall_faces(*args, **kwargs)	Sets color for wall faces.

Classes:

by_surface(path, service)	Enter the surface(s) color and material assignment menu.
by_type(path, service)	Enter the zone type color and material assignment menu.

automatic_skip(*args, **kwargs)

Specify whether the number of colormap labels is determined automatically. The default is yes.

axis_faces(*args, **kwargs)

Sets the color of axisymmetric faces.

background(*args, **kwargs)

Sets the background (window) color.

class by_surface(path, service)

Bases: TUIMenu

Enter the surface(s) color and material assignment menu.

Methods:

list_surfaces_by_color(*args, **kwargs)	To list the surfaces by its color.
list_surfaces_by_material(*args, **kwargs)	To list the surfaces by its material.
reset(*args, **kwargs)	To reset colors and/or materials to the defaults.
surfaces(*args, **kwargs)	Select the surface(s) to specify colors and/or materials.
use_inherent_material_color(*args, **kwargs)	Use inherent material color for surfaces.

list_surfaces_by_color(*args, **kwargs)

To list the surfaces by its color.

list_surfaces_by_material(*args, **kwargs)

To list the surfaces by its material.

reset(*args, **kwargs)

To reset colors and/or materials to the defaults.

surfaces(*args, **kwargs)

Select the surface(s) to specify colors and/or materials.

use_inherent_material_color(*args, **kwargs)

Use inherent material color for surfaces.

class by_type(path, service)

Bases: TUIMenu

Enter the zone type color and material assignment menu.

Methods:

only_list_case_boundaries(*args, **kwargs)	Only list the boundary types that are assigned in this case.
reset(*args, **kwargs)	To reset colors and/or materials to the defaults.
use_inherent_material_color(*args, **kwargs)	Use inherent material color for boundary zones.

Classes:

type_name(path, service)

Select the boundary type to specify colors and/or materials.

only_list_case_boundaries(*args, **kwargs)

Only list the boundary types that are assigned in this case.

reset(*args, **kwargs)

To reset colors and/or materials to the defaults.

class type_name(path, service)

Bases: TUIMenu

Select the boundary type to specify colors and/or materials.

Methods:

axis(*args, **kwargs)	Set the material and/or color for the selected boundary type.
far_field(*args, **kwargs)	Set the material and/or color for the selected boundary type.
free_surface(*args, **kwargs)	Set the material and/or color for the selected boundary type.
inlet(*args, **kwargs)	Set the material and/or color for the selected boundary type.
interface(*args, **kwargs)	Set the material and/or color for the selected boundary type.
interior(*args, **kwargs)	Set the material and/or color for the selected boundary type.
internal(*args, **kwargs)	Set the material and/or color for the selected boundary type.
outlet(*args, **kwargs)	Set the material and/or color for the selected boundary type.
overset(*args, **kwargs)	Set the material and/or color for the selected boundary type.
periodic(*args, **kwargs)	Set the material and/or color for the selected boundary type.
rans_les_interface(*args, **kwargs)	Set the material and/or color for the selected boundary type.
surface(*args, **kwargs)	Set the material and/or color for the selected boundary type.
symmetry(*args, **kwargs)	Set the material and/or color for the selected boundary type.
traction(*args, **kwargs)	Set the material and/or color for the selected boundary type.
wall(*args, **kwargs)	Set the material and/or color for the selected boundary type.

axis(*args, **kwargs)

Set the material and/or color for the selected boundary type.

far_field(*args, **kwargs)

Set the material and/or color for the selected boundary type.

free_surface(*args, **kwargs)

Set the material and/or color for the selected boundary type.

inlet(*args, **kwargs)

Set the material and/or color for the selected boundary type.

interface(*args, **kwargs)

Set the material and/or color for the selected boundary type.

interior(*args, **kwargs)

Set the material and/or color for the selected boundary type.

internal(*args, **kwargs)

Set the material and/or color for the selected boundary type.

outlet(*args, **kwargs)

Set the material and/or color for the selected boundary type.

overset(*args, **kwargs)

Set the material and/or color for the selected boundary type.

periodic(*args, **kwargs)

Set the material and/or color for the selected boundary type.

rans_les_interface(*args, **kwargs)

Set the material and/or color for the selected boundary type.

surface(*args, **kwargs)

Set the material and/or color for the selected boundary type.

symmetry(*args, **kwargs)

Set the material and/or color for the selected boundary type.

traction(*args, **kwargs)

Set the material and/or color for the selected boundary type.

wall(*args, **kwargs)

Set the material and/or color for the selected boundary type.

use_inherent_material_color(*args, **kwargs)

Use inherent material color for boundary zones.

color_by_type(*args, **kwargs)

Enables you to specify that the entities should be colored by their type or ID.

far_field_faces(*args, **kwargs)

Sets the color of far field faces.

foreground(*args, **kwargs)

Sets the foreground (text and window frame) color.

free_surface_faces(*args, **kwargs)

Sets the color of free surface faces.

graphics_color_theme(*args, **kwargs)

Sets the color theme for the graphics window. The color options (black, white, gray-gradient, or workbench) are for the background display, but changing the theme also changes the default colors for items that display in the graphics windows, like faces and edges.

grid_inlet(*args, **kwargs)

Set the color of inlet faces.

grid_interior(*args, **kwargs)

Set the color of interior faces.

highlight_color(*args, **kwargs)

Sets the highlight color.

inlet_faces(*args, **kwargs)

Sets the color of the inlet faces.

interface_faces(*args, **kwargs)

Sets the color of grid interface faces.

interior_faces(*args, **kwargs)

Sets the color of the interior faces.

internal_faces(*args, **kwargs)

Sets the color of the internal interface faces.

list(*args, **kwargs)

Lists the colors available for the selected zone type.

outlet_faces(*args, **kwargs)

Sets the color of the outlet faces.

overset_faces(*args, **kwargs)

Sets the color of the overset faces.

periodic_faces(*args, **kwargs)

Sets the color of periodic faces.

rans_les_interface_faces(*args, **kwargs)

Sets the color of RANS/LES interface faces.

reset_colors(*args, **kwargs)

Resets the individual grid surface colors to the defaults.

reset_user_colors(*args, **kwargs)

Resets individual grid surface colors to the defaults.

show_user_colors(*args, **kwargs)

Lists the current defined user colors.

skip_label(*args, **kwargs)

Sets the number of labels to be skipped in the colormap scale.

surface(*args, **kwargs)

Sets the color of surfaces.

symmetry_faces(*args, **kwargs)

Sets the color of symmetric faces.

traction_faces(*args, **kwargs)

Sets the color for traction faces.

user_color(*args, **kwargs)

Enables you to change the color for the specified zone.

wall_faces(*args, **kwargs)

Sets color for wall faces.

edges(*args, **kwargs)

Enables/disables the display of face/cell edges.

filled_grid(*args, **kwargs)

Enables/disables the filled grid option. When a grid is not filled, only its outline is drawn.

highlight_tree_selection(*args, **kwargs)

Turn on/off outline display of tree selection in graphics window.

class lights(path, service)

Bases: TUIMenu

Enters the lights menu.

Methods:

headlight_on(*args, **kwargs)	Turns the light that moves with the camera on or off.
lighting_interpolation(*args, **kwargs)	Sets the lighting interpolation method to be used.
lights_on(*args, **kwargs)	Enables/disables the display of all lights.
set_ambient_color(*args, **kwargs)	Sets the ambient color for the scene.
set_light(*args, **kwargs)	Adds or modifies a directional, colored light.

headlight_on(*args, **kwargs)

Turns the light that moves with the camera on or off. This is controlled automatically by default.

lighting_interpolation(*args, **kwargs)

Sets the lighting interpolation method to be used. You can choose automatic, flat, gouraud, or phong. “Automatic” automatically picks the best lighting method for the display in the graphics window. Flat is the most basic method, and the others are more sophisticated and provide smoother gradations of color.

lights_on(*args, **kwargs)

Enables/disables the display of all lights.

set_ambient_color(*args, **kwargs)

Sets the ambient color for the scene. The ambient color is the background light color in scene.

set_light(*args, **kwargs)

Adds or modifies a directional, colored light.

line_weight(*args, **kwargs)

Sets the line width factor for the window.

native_display_defaults(*args, **kwargs)

Resets graphics window parameters to optimal settings for a local display. Used after setting parameters for a remote display with remote-display-defaults.

overlays(*args, **kwargs)

Turns overlays on and off.

class picture(path, service)

Bases: TUIMenu

Saves a hardcopy file of the active graphics window.

Classes:

color_mode(path, service)	Contains the available color modes.
driver(path, service)	Contains the available hardcopy formats.

Methods:

dpi(*args, **kwargs)	Specifies the resolution in dots per inch for EPS and PostScript files.
invert_background(*args, **kwargs)	Enables/disables the exchange of foreground/background colors for hardcopy files.
jpeg_hardcopy_quality(*args, **kwargs)	Controls the size and quality of how JPEG files are saved based on a scale of 0-100, with zero being low quality small files and 100 being high quality larger files.
landscape(*args, **kwargs)	Toggles between landscape or portrait orientation.
preview(*args, **kwargs)	Applies the settings of the color-mode, invert-background, and landscape options to the currently active graphics window to preview the appearance of printed hardcopies.
raytracer_image(*args, **kwargs)	Enable raytracering rendering.
set_standard_resolution(*args, **kwargs)	Select from pre-defined resolution list.
use_window_resolution(*args, **kwargs)	Disables/enables the use of the current graphics window resolution when saving an image of the graphics window.
x_resolution(*args, **kwargs)	Sets the width of the raster format images in pixels (0 implies that the hardcopy should use the same resolution as the active graphics window).
y_resolution(*args, **kwargs)	Sets the height of the raster format images in pixels (0 implies that the hardcopy should use the same resolution as the active graphics window).

class color_mode(path, service)

Bases: TUIMenu

Contains the available color modes.

Methods:

color(*args, **kwargs)	Selects full color and plots the hardcopy in color.
gray_scale(*args, **kwargs)	Selects gray scale (that is, various shades of gray) and converts color to gray-scale for hardcopy.
list(*args, **kwargs)	Displays the current hardcopy color mode.
mono_chrome(*args, **kwargs)	Selects color to monochrome (black and white) for hardcopy.

color(*args, **kwargs)

Selects full color and plots the hardcopy in color.

gray_scale(*args, **kwargs)

Selects gray scale (that is, various shades of gray) and converts color to gray-scale for hardcopy.

list(*args, **kwargs)

Displays the current hardcopy color mode.

mono_chrome(*args, **kwargs)

Selects color to monochrome (black and white) for hardcopy.

dpi(*args, **kwargs)

Specifies the resolution in dots per inch for EPS and PostScript files.

class driver(path, service)

Bases: TUIMenu

Contains the available hardcopy formats.

Methods:

avz(*args, **kwargs)	Use AVZ output for hardcopies.
dump_window(*args, **kwargs)	Sets the command to dump a graphics window to a file.
eps(*args, **kwargs)	Sets the Encapsulated PostScript format.
glb(*args, **kwargs)	Produces GLB output for hardcopies.
hsf(*args, **kwargs)	Produces HOOPS Visualize Stream Format (HSF) output for hardcopies.
jpeg(*args, **kwargs)	Sets the JPEG image format.
list(*args, **kwargs)	Displays the current hardcopy format.
options(*args, **kwargs)	Enables you to set hardcopy options, such as landscape orientation, pen speed, and physical size.
png(*args, **kwargs)	Sets the PNG image format.
post_script(*args, **kwargs)	Sets the PostScript format.
ppm(*args, **kwargs)	Sets the PPM format.
tiff(*args, **kwargs)	Sets the TIFF format.
vrml(*args, **kwargs)	Sets the VRML format.

Classes:

post_format(path, service)

Contains commands for setting the PostScript driver format and save files in PS files that can be printed quickly.

avz(*args, **kwargs)

Use AVZ output for hardcopies.

dump_window(*args, **kwargs)

Sets the command to dump a graphics window to a file.

eps(*args, **kwargs)

Sets the Encapsulated PostScript format.

glb(*args, **kwargs)

Produces GLB output for hardcopies.

hsf(*args, **kwargs)

Produces HOOPS Visualize Stream Format (HSF) output for hardcopies.

jpeg(*args, **kwargs)

Sets the JPEG image format.

list(*args, **kwargs)

Displays the current hardcopy format.

options(*args, **kwargs)

Enables you to set hardcopy options, such as landscape orientation, pen speed, and physical size. The options may be entered on one line if you separate them with commas.

png(*args, **kwargs)

Sets the PNG image format.

class post_format(path, service)

Bases: TUIMenu

Contains commands for setting the PostScript driver format and save files in PS files that can be printed quickly.

Methods:

fast_raster(*args, **kwargs)	Enables a raster file that may be larger than the standard raster file, but will print much more quickly.
raster(*args, **kwargs)	Enables the standard raster file.
rle_raster(*args, **kwargs)	Enables a run-length encoded raster file that will be about the same size as the standard raster file, but will print slightly more quickly.
vector(*args, **kwargs)	Enables the standard vector file.

fast_raster(*args, **kwargs)

Enables a raster file that may be larger than the standard raster file, but will print much more quickly.

raster(*args, **kwargs)

Enables the standard raster file.

rle_raster(*args, **kwargs)

Enables a run-length encoded raster file that will be about the same size as the standard raster file, but will print slightly more quickly. This is the default file type.

vector(*args, **kwargs)

Enables the standard vector file.

post_script(*args, **kwargs)

Sets the PostScript format.

ppm(*args, **kwargs)

Sets the PPM format.

tiff(*args, **kwargs)

Sets the TIFF format.

vrml(*args, **kwargs)

Sets the VRML format.

invert_background(*args, **kwargs)

Enables/disables the exchange of foreground/background colors for hardcopy files.

jpeg_hardcopy_quality(*args, **kwargs)

Controls the size and quality of how JPEG files are saved based on a scale of 0-100, with zero being low quality small files and 100 being high quality larger files.

landscape(*args, **kwargs)

Toggles between landscape or portrait orientation.

preview(*args, **kwargs)

Applies the settings of the color-mode, invert-background, and landscape options to the currently active graphics window to preview the appearance of printed hardcopies.

raytracer_image(*args, **kwargs)

Enable raytracering rendering.

set_standard_resolution(*args, **kwargs)

Select from pre-defined resolution list.

use_window_resolution(*args, **kwargs)

Disables/enables the use of the current graphics window resolution when saving an image of the graphics window. If disabled, the resolution will be as specified for x-resolution and y-resolution.

x_resolution(*args, **kwargs)

Sets the width of the raster format images in pixels (0 implies that the hardcopy should use the same resolution as the active graphics window).

y_resolution(*args, **kwargs)

Sets the height of the raster format images in pixels (0 implies that the hardcopy should use the same resolution as the active graphics window).

quick_moves_algorithm(*args, **kwargs)

Select quick moves algorithm for icons and helptext overlay.

re_render(*args, **kwargs)

Re-renders the current window after modifying the variables in the set menu.

remote_display_defaults(*args, **kwargs)

Adjusts graphics window parameters to optimal settings for a remote display. Restore parameters for local display using native-display-defaults.

class rendering_options(path, service)

Bases: TUIMenu

Contains the commands that enable you to set options that determine how the scene is rendered.

Methods:

animation_option(*args, **kwargs)	Enables you to specify the animation option as appropriate.
auto_spin(*args, **kwargs)	Enables mouse view rotations to continue to spin the display after the button is released.
color_map_alignment(*args, **kwargs)	Sets the color bar alignment.
device_info(*args, **kwargs)	Prints out information about your graphics driver.
double_buffering(*args, **kwargs)	Enables or disables double buffering.
driver(*args, **kwargs)	Changes the current graphics driver.
face_displacement(*args, **kwargs)	Sets the face displacement (in Z-buffer units along the camera Z-axis) for the displayed geometry when both faces and edges are displayed simultaneously.
help_text_color(*args, **kwargs)	Sets the color of the help text on the screen.
hidden_line_method(*args, **kwargs)	Specifies the method to perform hidden line rendering.
hidden_lines(*args, **kwargs)	Turns hidden line removal on or off.
hidden_surface_method(*args, **kwargs)	Enables you to choose from among the hidden surface removal methods that are supported.
hidden_surfaces(*args, **kwargs)	Enables/disables the display of hidden surfaces.
outer_face_cull(*args, **kwargs)	Enables/disables the display of outer faces.
set_rendering_options(*args, **kwargs)	Sets the rendering options.
show_colormap(*args, **kwargs)	Enable/Disable colormap.
surface_edge_visibility(*args, **kwargs)	Controls whether or not the mesh edges are drawn.

animation_option(*args, **kwargs)

Enables you to specify the animation option as appropriate.

auto_spin(*args, **kwargs)

Enables mouse view rotations to continue to spin the display after the button is released.

color_map_alignment(*args, **kwargs)

Sets the color bar alignment.

device_info(*args, **kwargs)

Prints out information about your graphics driver.

double_buffering(*args, **kwargs)

Enables or disables double buffering. Double buffering dramatically reduces screen flicker during graphics updates. If your display hardware does not support double buffering and you turn this option on, double buffering will be done in software. Software double buffering uses extra memory.

driver(*args, **kwargs)

Changes the current graphics driver. When enabling graphics display, you have various options: for Linux, the available drivers include opengl and x11; for Windows, the available drivers include opengl, dx11 (for DirectX 11), and msw (for Microsoft Windows). You can also disable the graphics display window by entering null. For a comprehensive list of the drivers available to you, press the Enter key at the driver> prompt. For any session that displays graphics in a graphics window and/or saves picture files, having the driver set to x11, msw, or null will cause the rendering / saving speed to be significantly slower.

face_displacement(*args, **kwargs)

Sets the face displacement (in Z-buffer units along the camera Z-axis) for the displayed geometry when both faces and edges are displayed simultaneously.

help_text_color(*args, **kwargs)

Sets the color of the help text on the screen. You can select black, default, or white.

hidden_line_method(*args, **kwargs)

Specifies the method to perform hidden line rendering. This command will appear only when hidden-lines? is true.

hidden_lines(*args, **kwargs)

Turns hidden line removal on or off. This command is available only when the color scheme is set to classic. This command (only available when Graphics Color Theme is set to Black) is deprecated and will be removed at a future release.

hidden_surface_method(*args, **kwargs)

Enables you to choose from among the hidden surface removal methods that are supported. These options (listed below) are display hardware dependent.

hidden_surfaces(*args, **kwargs)

Enables/disables the display of hidden surfaces.

outer_face_cull(*args, **kwargs)

Enables/disables the display of outer faces.

set_rendering_options(*args, **kwargs)

Sets the rendering options.

show_colormap(*args, **kwargs)

Enable/Disable colormap.

surface_edge_visibility(*args, **kwargs)

Controls whether or not the mesh edges are drawn.

reset_graphics(*args, **kwargs)

Resets the graphics system.

shrink_factor(*args, **kwargs)

Sets shrinkage of both faces and cells. A value of zero indicates no shrinkage, while a value of one would shrink the face or cell to a point.

class styles(path, service)

Bases: TUIMenu

Contains commands for setting the display style for the different types of nodes and faces that can be displayed.

Methods:

dummy(*args, **kwargs)

.

dummy(*args, **kwargs)

.

title(*args, **kwargs)

Sets the problem title.

windows(*args, **kwargs)

Enters the windows options menu, which contains commands that enable you to customize the relative positions of sub-windows inside the active graphics window.

class set_grid(path, service)

Bases: TUIMenu

Contains options controlling the display of the grid.

Methods:

all_cells(*args, **kwargs)	Enables/disables the display of all cells.
all_faces(*args, **kwargs)	Enables/disables the display of all faces.
all_nodes(*args, **kwargs)	Enables/disables the display of all nodes.
cell_quality(*args, **kwargs)	Sets the lower and upper bounds of quality for cells to be displayed.
default(*args, **kwargs)	Resets the grid display parameters to their default values.
face_quality(*args, **kwargs)	Sets the lower and upper bounds of quality for faces to be displayed.
free(*args, **kwargs)	Enables/disables the drawing of faces/nodes that have no neighboring face on at least one edge.
label_alignment(*args, **kwargs)	Sets the alignment of labels that appear in the graphics window.
label_font(*args, **kwargs)	Sets the label font.
label_scale(*args, **kwargs)	Scales the size of the label.
labels(*args, **kwargs)	Enables/disables the display of labels.
left_handed(*args, **kwargs)	Enables/disables the display of left-handed faces.
list(*args, **kwargs)	Lists all the grid display settings.
marked(*args, **kwargs)	Enables/disables the display of marked nodes.
multi(*args, **kwargs)	Enables/disables the display of those faces/nodes that have more than one neighboring face on an edge.
neighborhood(*args, **kwargs)	Sets the x, y, and z range to be within a specified neighborhood of a specified grid object.
node_size(*args, **kwargs)	Sets the node symbol scaling factor.
node_symbol(*args, **kwargs)	Specifies the node symbol.
normal_scale(*args, **kwargs)	Sets the scale factor for face normals.
normals(*args, **kwargs)	Enables/disables the display of face normals.
refine(*args, **kwargs)	Enables/disables the display of those faces that have been marked for refinement.
tagged(*args, **kwargs)	Enables/disables the display of tagged nodes.
unmeshed(*args, **kwargs)	Enables/disables the display of nodes and faces that have not been meshed.
unused(*args, **kwargs)	Enables/disables the display of unused nodes.
x_range(*args, **kwargs)	Limits the display of grid objects to the specified x-range.
y_range(*args, **kwargs)	Limits the display of grid objects to the specified y-range.
z_range(*args, **kwargs)	Limits the display of grid objects to the specified z-range.

all_cells(*args, **kwargs)

Enables/disables the display of all cells.

all_faces(*args, **kwargs)

Enables/disables the display of all faces.

all_nodes(*args, **kwargs)

Enables/disables the display of all nodes.

cell_quality(*args, **kwargs)

Sets the lower and upper bounds of quality for cells to be displayed. Only cells with a quality measure value (for example, skewness) within the specified range will be displayed.

default(*args, **kwargs)

Resets the grid display parameters to their default values.

face_quality(*args, **kwargs)

Sets the lower and upper bounds of quality for faces to be displayed. Only faces with a quality measure value (for example, skewness) within the specified range will be displayed.

free(*args, **kwargs)

Enables/disables the drawing of faces/nodes that have no neighboring face on at least one edge.

label_alignment(*args, **kwargs)

Sets the alignment of labels that appear in the graphics window. By default, the label is centered on the node, cell, and so on, to which the label refers. You can specify *,ˆ, v, <, > for center, top, bottom, left, or right. You can also combine symbols—for example, “*v” for bottom center.

label_font(*args, **kwargs)

Sets the label font. By default, all labels appear in “sans serif” font. Some other choices are roman, typewriter, and stroked.

label_scale(*args, **kwargs)

Scales the size of the label.

labels(*args, **kwargs)

Enables/disables the display of labels.

left_handed(*args, **kwargs)

Enables/disables the display of left-handed faces.

list(*args, **kwargs)

Lists all the grid display settings.

marked(*args, **kwargs)

Enables/disables the display of marked nodes.

multi(*args, **kwargs)

Enables/disables the display of those faces/nodes that have more than one neighboring face on an edge.

neighborhood(*args, **kwargs)

Sets the x, y, and z range to be within a specified neighborhood of a specified grid object.

node_size(*args, **kwargs)

Sets the node symbol scaling factor.

node_symbol(*args, **kwargs)

Specifies the node symbol.

normal_scale(*args, **kwargs)

Sets the scale factor for face normals.

normals(*args, **kwargs)

Enables/disables the display of face normals.

refine(*args, **kwargs)

Enables/disables the display of those faces that have been marked for refinement.

tagged(*args, **kwargs)

Enables/disables the display of tagged nodes.

unmeshed(*args, **kwargs)

Enables/disables the display of nodes and faces that have not been meshed.

unused(*args, **kwargs)

Enables/disables the display of unused nodes.

x_range(*args, **kwargs)

Limits the display of grid objects to the specified x-range.

y_range(*args, **kwargs)

Limits the display of grid objects to the specified y-range.

z_range(*args, **kwargs)

Limits the display of grid objects to the specified z-range.

set_list_tree_separator(*args, **kwargs)

Sets the separator character to be used to determine the common prefix for items listed in the selection lists, when the tree view is used.

show_hide_clipping_plane_triad(*args, **kwargs)

update_layout(*args, **kwargs)

Update the fluent layout.

class update_scene(path, service)

Bases: TUIMenu

Contains commands that enable you to update the scene description.

Methods:

delete(*args, **kwargs)	Deletes the geometry selected using the select-geometry command.
display(*args, **kwargs)	Displays the geometry selected using the select-geometry command.
draw_frame(*args, **kwargs)	Enables/disables the drawing of the bounding frame.
iso_sweep(*args, **kwargs)	Changes iso-sweep values.
overlays(*args, **kwargs)	Enables/disables the overlays option.
pathline(*args, **kwargs)	Changes pathline attributes.
select_geometry(*args, **kwargs)	Enables you to select the geometry to be updated.
set_frame(*args, **kwargs)	Enables you to change the frame options.
time(*args, **kwargs)	Changes time-step value.
transform(*args, **kwargs)	Enables you to apply the transformation matrix to the geometry selected using the select-geometry command.

delete(*args, **kwargs)

Deletes the geometry selected using the select-geometry command.

display(*args, **kwargs)

Displays the geometry selected using the select-geometry command.

draw_frame(*args, **kwargs)

Enables/disables the drawing of the bounding frame.

iso_sweep(*args, **kwargs)

Changes iso-sweep values.

overlays(*args, **kwargs)

Enables/disables the overlays option.

pathline(*args, **kwargs)

Changes pathline attributes.

select_geometry(*args, **kwargs)

Enables you to select the geometry to be updated.

set_frame(*args, **kwargs)

Enables you to change the frame options.

time(*args, **kwargs)

Changes time-step value.

transform(*args, **kwargs)

Enables you to apply the transformation matrix to the geometry selected using the select-geometry command.

views(*args, **kwargs)

Enters the view window options menu.

class xy_plot(path, service)

Bases: TUIMenu

Enters the XY plot menu.

Methods:

cell_distribution(*args, **kwargs)	Plots a histogram of cell quality.
face_distribution(*args, **kwargs)	Plots a histogram of face quality.
file(*args, **kwargs)	Enables you to choose a file from which to create an xy plot.
set(*args, **kwargs)	Enters the set window options menu.

cell_distribution(*args, **kwargs)

Plots a histogram of cell quality.

face_distribution(*args, **kwargs)

Plots a histogram of face quality.

file(*args, **kwargs)

Enables you to choose a file from which to create an xy plot.

set(*args, **kwargs)

Enters the set window options menu.

class zones(path, service)

Bases: TUIMenu

Contains commands for displaying zones.

Methods:

display_neighborhood(*args, **kwargs)	Displays the zones that are in the neighborhood of the selected zones.
display_similar_area(*args, **kwargs)	Displays the zones with similar area to the selected zone area.
hide_zones(*args, **kwargs)	Hides the selected zones in the display.
isolate_zones(*args, **kwargs)	Displays only the selected zones.
make_transparent(*args, **kwargs)	Makes the geometry transparent so that internal zones are visible.
select_all_visible(*args, **kwargs)	Selects all the visible zones in the graphics window.
show_all(*args, **kwargs)	Unhides all the zones in the geometry and displays them.
toggle_color_mode(*args, **kwargs)	Toggles the colors of the geometry.
toggle_color_palette(*args, **kwargs)	Toggles the color palette of the geometry.

display_neighborhood(*args, **kwargs)

Displays the zones that are in the neighborhood of the selected zones. The neighboring zones have to be in contact, or intersecting the selected zone.

display_similar_area(*args, **kwargs)

Displays the zones with similar area to the selected zone area.

hide_zones(*args, **kwargs)

Hides the selected zones in the display.

isolate_zones(*args, **kwargs)

Displays only the selected zones.

make_transparent(*args, **kwargs)

Makes the geometry transparent so that internal zones are visible. This command works as a toggle undoing the transparency of the previously selected zones.

select_all_visible(*args, **kwargs)

Selects all the visible zones in the graphics window.

show_all(*args, **kwargs)

Unhides all the zones in the geometry and displays them.

toggle_color_mode(*args, **kwargs)

Toggles the colors of the geometry. In one mode geometry is colored object-wise while in the other mode it is colored zone-wise.

toggle_color_palette(*args, **kwargs)

Toggles the color palette of the geometry.