display#

class ansys.fluent.core.solver.tui_231.main_menu.display(path, service)#

Bases: TUIMenu

Enter the display menu.

Methods:

add_custom_vector(*args, **kwargs)

Adds new custom vector definition.

annotate(*args, **kwargs)

Add a text annotation string to the active graphics window.

clear_annotations(*args, **kwargs)

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

close_window(*args, **kwargs)

Close a "user" graphics window.

close_window_by_name(*args, **kwargs)

Close a reserved graphics window (windows used for residuals, report plots, and animation definitions).

contour(*args, **kwargs)

Prompts for a scalar field and minimum and maximum values, and then displays a contour plot.

display_custom_vector(*args, **kwargs)

Displays custom vector.

graphics_window_layout(*args, **kwargs)

Arranges the graphics window layout.

hsf_file(*args, **kwargs)

Loads an HSF file for viewing.

mesh(*args, **kwargs)

Displays the entire mesh.

mesh_outline(*args, **kwargs)

Displays the mesh boundaries.

mesh_partition_boundary(*args, **kwargs)

Displays mesh partition boundaries.

multigrid_coarsening(*args, **kwargs)

Displays a coarse mesh level from the last multigrid coarsening.

open_window(*args, **kwargs)

Opens a graphics window.

profile(*args, **kwargs)

Displays profiles of a flow variable.

re_render(*args, **kwargs)

Re-renders the last contour, profile, or vector plot with updated surfaces, meshed, lights, colormap, rendering options, and so on, without recalculating the contour data.

re_scale(*args, **kwargs)

Re-renders the last contour, profile, or vector plot with updated scale, surfaces, meshes, lights, colormap, rendering options, and so on, but without recalculating the field data.

reacting_channel_curves(*args, **kwargs)

Plots the reacting channel variables.

save_picture(*args, **kwargs)

Generate a "hardcopy" of the active window.

set_list_tree_separator(*args, **kwargs)

Set the separator character for list tree.

set_window(*args, **kwargs)

Sets a "user" graphics window to be the active window.

set_window_by_name(*args, **kwargs)

Sets the specified graphics window as active.

surface_cells(*args, **kwargs)

Draws the cells on the specified surfaces.

surface_mesh(*args, **kwargs)

Draws the mesh defined by the specified surfaces.

switch_to_post_processing_volume(*args, **kwargs)

Switch to post processing volume.

switch_to_primary_volume(*args, **kwargs)

Switch to primary volume.

update_layout(*args, **kwargs)

Update the fluent layout.

vector(*args, **kwargs)

Displays vectors of a space vector variable.

velocity_vector(*args, **kwargs)

Prompts for a scalar field by which to color the vectors, the minimum and maximum values, and the scale factor, and then draws the velocity vectors.

zone_mesh(*args, **kwargs)

Draws the mesh defined by specified face zones.

Classes:

define(path, service)

Enter Display define menu.

display_states(path, service)

Enter the display state manipulation menu.

embedded_windows(path, service)

Enter the embedded window menu.

flamelet_data(path, service)

Displays flamelet data.

inverse_dft(path, service)

Reconstruct DFT signal.

objects(path, service)

Enter to add, edit, delete or display graphics objects.

particle_tracks(path, service)

Enters the particle tracks menu.

path_lines(path, service)

Enters the pathlines menu.

pdf_data(path, service)

Enters the PDF data menu.

set(path, service)

Enter the set menu to set display parameters.

surface(path, service)

Enters the data surface-manipulation menu.

update_scene(path, service)

Enter the scene options menu.

view_sync(path, service)

Synchronize window views.

views(path, service)

Enter the view manipulation menu.
add_custom_vector(*args, **kwargs)#

Adds new custom vector definition.

annotate(*args, **kwargs)#

Add a text annotation string to the active graphics window.

clear_annotations(*args, **kwargs)#

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

close_window(*args, **kwargs)#

Close a “user” graphics window. User windows are specified by number (1-50), with the associated number corresponding to the order, left-to-right, that the windows were created in.

close_window_by_name(*args, **kwargs)#

Close a reserved graphics window (windows used for residuals, report plots, and animation definitions).

contour(*args, **kwargs)#

Prompts for a scalar field and minimum and maximum values, and then displays a contour plot.

class define(path, service)#

Bases: TUIMenu

Enter Display define menu.

Classes:

material(path, service)

Add, Edit, Remove materials in case file.
class material(path, service)#

Bases: TUIMenu

Add, Edit, Remove materials in case file.

Methods:

copy(*args, **kwargs)

Copy to new material.

delete(*args, **kwargs)

Remove material.

edit(*args, **kwargs)

Edit material.

new(*args, **kwargs)

Create new material.
copy(*args, **kwargs)#

Copy to new material.

delete(*args, **kwargs)#

Remove material.

edit(*args, **kwargs)#

Edit material.

new(*args, **kwargs)#

Create new material.

display_custom_vector(*args, **kwargs)#

Displays custom vector.

class display_states(path, service)#

Bases: TUIMenu

Enter the display state manipulation menu.

Methods:

apply(*args, **kwargs)

Apply a display state to the active window.

copy(*args, **kwargs)

Create a new display state with settings copied from an existing display state.

create(*args, **kwargs)

Create a new display state.

delete(*args, **kwargs)

Delete a display state.

edit(*args, **kwargs)

Edit a particular display state setting.

list(*args, **kwargs)

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

read(*args, **kwargs)

Read display states from a file.

use_active(*args, **kwargs)

Update an existing display state's settings to match those of the active graphics window.

write(*args, **kwargs)

Write display states to a file.
apply(*args, **kwargs)#

Apply a display state to the active window.

copy(*args, **kwargs)#

Create a new display state with settings copied from an existing display state.

create(*args, **kwargs)#

Create a new display state.

delete(*args, **kwargs)#

Delete a display state.

edit(*args, **kwargs)#

Edit a particular display state setting.

list(*args, **kwargs)#

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

read(*args, **kwargs)#

Read display states from a file.

use_active(*args, **kwargs)#

Update an existing display state’s settings to match those of the active graphics window.

write(*args, **kwargs)#

Write display states to a file.

class embedded_windows(path, service)#

Bases: TUIMenu

Enter the embedded window menu.

Methods:

close(*args, **kwargs)

Close an embedded window.

close_all(*args, **kwargs)

Close all the embedded windows within the specified parent window.

embed_in(*args, **kwargs)

Specify a window to embed and a parent window to receive the embedded window.

move_out(*args, **kwargs)

Move an embedded window out of the parent window, returning the embedded window to a non-embedded state.

move_out_all(*args, **kwargs)

Move all the embedded windows out of the specified parent window.
close(*args, **kwargs)#

Close an embedded window.

close_all(*args, **kwargs)#

Close all the embedded windows within the specified parent window.

embed_in(*args, **kwargs)#

Specify a window to embed and a parent window to receive the embedded window.

move_out(*args, **kwargs)#

Move an embedded window out of the parent window, returning the embedded window to a non-embedded state.

move_out_all(*args, **kwargs)#

Move all the embedded windows out of the specified parent window.

class flamelet_data(path, service)#

Bases: TUIMenu

Displays flamelet data.

Methods:

carpet_plot(*args, **kwargs)

Enables/disables display of carpet plot of a property.

draw_number_box(*args, **kwargs)

Enables/disables display of the numbers box.

plot_1d_slice(*args, **kwargs)

Enables/disables plot of the 1D-slice.

write_to_file(*args, **kwargs)

Enables/disables writing the 1D-slice to file instead of plot.
carpet_plot(*args, **kwargs)#

Enables/disables display of carpet plot of a property.

draw_number_box(*args, **kwargs)#

Enables/disables display of the numbers box.

plot_1d_slice(*args, **kwargs)#

Enables/disables plot of the 1D-slice.

write_to_file(*args, **kwargs)#

Enables/disables writing the 1D-slice to file instead of plot.

graphics_window_layout(*args, **kwargs)#

Arranges the graphics window layout.

hsf_file(*args, **kwargs)#

Loads an HSF file for viewing.

class inverse_dft(path, service)#

Bases: TUIMenu

Reconstruct DFT signal.

Methods:

reconstruct(*args, **kwargs)

Make inverse DFT recontruction.

set(*args, **kwargs)

Set reconstruction parameters.
reconstruct(*args, **kwargs)#

Make inverse DFT recontruction.

set(*args, **kwargs)#

Set reconstruction parameters.

mesh(*args, **kwargs)#

Displays the entire mesh. For 3D, you will be asked to confirm that you really want to draw the entire mesh (not just themesh-outline).

mesh_outline(*args, **kwargs)#

Displays the mesh boundaries.

mesh_partition_boundary(*args, **kwargs)#

Displays mesh partition boundaries.

multigrid_coarsening(*args, **kwargs)#

Displays a coarse mesh level from the last multigrid coarsening.

class objects(path, service)#

Bases: TUIMenu

Enter to add, edit, delete or display graphics objects.

Methods:

add_to_graphics(*args, **kwargs)

Add graphics object to existing graphics.

copy(*args, **kwargs)

Copy graphics object.

create(*args, **kwargs)

Create new graphics object.

delete(*args, **kwargs)

Delete graphics object.

display(*args, **kwargs)

Display graphics object.

edit(*args, **kwargs)

Edit graphics object.
add_to_graphics(*args, **kwargs)#

Add graphics object to existing graphics.

copy(*args, **kwargs)#

Copy graphics object.

create(*args, **kwargs)#

Create new graphics object.

delete(*args, **kwargs)#

Delete graphics object.

display(*args, **kwargs)#

Display graphics object.

edit(*args, **kwargs)#

Edit graphics object.

open_window(*args, **kwargs)#

Opens a graphics window.

class particle_tracks(path, service)#

Bases: TUIMenu

Enters the particle tracks menu.

Methods:

particle_tracks(*args, **kwargs)

Calculates and displays particle tracks from defined injections.

plot_write_xy_plot(*args, **kwargs)

Plots or writes an XY plot of particle tracks.
particle_tracks(*args, **kwargs)#

Calculates and displays particle tracks from defined injections.

plot_write_xy_plot(*args, **kwargs)#

Plots or writes an XY plot of particle tracks.

class path_lines(path, service)#

Bases: TUIMenu

Enters the pathlines menu.

Methods:

path_lines(*args, **kwargs)

Displays pathlines from a surface.

plot_write_xy_plot(*args, **kwargs)

Plots or writes an XY plot of pathlines.

write_to_files(*args, **kwargs)

Writes pathlines to a file.
path_lines(*args, **kwargs)#

Displays pathlines from a surface.

plot_write_xy_plot(*args, **kwargs)#

Plots or writes an XY plot of pathlines.

write_to_files(*args, **kwargs)#

Writes pathlines to a file.

class pdf_data(path, service)#

Bases: TUIMenu

Enters the PDF data menu.

Methods:

carpet_plot(*args, **kwargs)

Enables/disables the display of a carpet plot of a property.

draw_number_box(*args, **kwargs)

Enables/disables the display of the numbers box.

plot_1d_slice(*args, **kwargs)

Enables/disables a plot of the 1D-slice.

write_to_file(*args, **kwargs)

Enables/disables writing the 1D-slice to file instead of plot.
carpet_plot(*args, **kwargs)#

Enables/disables the display of a carpet plot of a property.

draw_number_box(*args, **kwargs)#

Enables/disables the display of the numbers box.

plot_1d_slice(*args, **kwargs)#

Enables/disables a plot of the 1D-slice.

write_to_file(*args, **kwargs)#

Enables/disables writing the 1D-slice to file instead of plot.

profile(*args, **kwargs)#

Displays profiles of a flow variable.

re_render(*args, **kwargs)#

Re-renders the last contour, profile, or vector plot with updated surfaces, meshed, lights, colormap, rendering options, and so on, without recalculating the contour data.

re_scale(*args, **kwargs)#

Re-renders the last contour, profile, or vector plot with updated scale, surfaces, meshes, lights, colormap, rendering options, and so on, but without recalculating the field data.

reacting_channel_curves(*args, **kwargs)#

Plots the reacting channel variables.

save_picture(*args, **kwargs)#

Generate a “hardcopy” of the active window.

class set(path, service)#

Bases: TUIMenu

Enter the set menu to set display parameters.

Methods:

color_map(*args, **kwargs)

Enters the color map menu, which contains names of predefined and user-defined (in the Colormap Editor panel) colormaps that can be selected.

duplicate_node_display(*args, **kwargs)

Set flag to remove duplicate nodes in mesh display.

element_shrink(*args, **kwargs)

Sets shrinkage of both faces and cells.

filled_mesh(*args, **kwargs)

Determines whether the meshes are drawn as wireframe or solid.

line_weight(*args, **kwargs)

Set the line-weight factor for the window.

marker_size(*args, **kwargs)

Sets the size of markers used to represent points.

marker_symbol(*args, **kwargs)

Sets the type of markers used to represent points.

mesh_display_configuration(*args, **kwargs)

Changes the default mesh display.

mesh_level(*args, **kwargs)

Sets coarse mesh level to be drawn.

mesh_partitions(*args, **kwargs)

Enables/disables option to draw mesh partition boundaries.

mesh_surfaces(*args, **kwargs)

Sets surface IDs to be drawn as meshes.

mesh_zones(*args, **kwargs)

Sets zone IDs to be drawn as meshes.

mirror_zones(*args, **kwargs)

Sets the zones about which the domain is mirrored (symmetry planes).

n_stream_func(*args, **kwargs)

Sets number of iterations used in computing stream function.

nodewt_based_interp(*args, **kwargs)

Disables/enables the use of node weights for node-based gradients in postprocessing.

overlays(*args, **kwargs)

Enable/disable overlays.

periodic_instancing(*args, **kwargs)

Sets the number of periodic repetitions.

proximity_zones(*args, **kwargs)

Sets zones to be used for boundary cell distance and boundary proximity.

render_mesh(*args, **kwargs)

Enables/disables rendering the mesh on top of contours, vectors, and so on.

reset_graphics(*args, **kwargs)

Reset the graphics system.

zero_angle_dir(*args, **kwargs)

Sets the vector having zero angular coordinates.

Classes:

colors(path, service)

Enter the color options menu.

contours(path, service)

Enters the contour options menu.

lights(path, service)

Enter the lights menu.

particle_tracks(path, service)

Enters the particle-tracks menu to set parameters for display of particle tracks.

path_lines(path, service)

Sets parameters for display of pathlines.

picture(path, service)

Enter the hardcopy/save-picture options menu.

rendering_options(path, service)

Enter the rendering options menu.

titles(path, service)

Set problem title.

velocity_vectors(path, service)

Enters the menu to set parameters for display of velocity vectors.

windows(path, service)

Enter the window options menu.
color_map(*args, **kwargs)#

Enters the color map menu, which contains names of predefined and user-defined (in the Colormap Editor panel) colormaps that can be selected. It prompts you for the name of the colormap to be used.

class colors(path, service)#

Bases: TUIMenu

Enter the color options menu.

Methods:

automatic_skip(*args, **kwargs)

Determine whether to skip labels in the colopmap scale automatically.

axis_faces(*args, **kwargs)

Set the color of axisymmetric faces.

background(*args, **kwargs)

Set the background (window) color.

color_by_type(*args, **kwargs)

Determine whether to color meshes by type or by surface (ID).

far_field_faces(*args, **kwargs)

Set the color of far field faces.

foreground(*args, **kwargs)

Set the foreground (text and window frame) color.

free_surface_faces(*args, **kwargs)

Set the color of free-surface faces.

graphics_color_theme(*args, **kwargs)

Enter the graphics color theme menu.

inlet_faces(*args, **kwargs)

Set the color of inlet faces.

interface_faces(*args, **kwargs)

Set the color of mesh Interfaces.

interior_faces(*args, **kwargs)

Set the color of interior faces.

internal_faces(*args, **kwargs)

Set the color of internal interface faces.

list(*args, **kwargs)

List available colors.

outlet_faces(*args, **kwargs)

Set the color of outlet faces.

overset_faces(*args, **kwargs)

Set the color of overset faces.

periodic_faces(*args, **kwargs)

Set the color of periodic faces.

rans_les_interface_faces(*args, **kwargs)

Set the color of RANS/LES interface faces.

reset_colors(*args, **kwargs)

Reset individual mesh surface colors to the defaults.

reset_user_colors(*args, **kwargs)

Reset all user colors.

show_user_colors(*args, **kwargs)

List currently defined user colors.

skip_label(*args, **kwargs)

Set the number of labels to be skipped in the colopmap scale.

surface(*args, **kwargs)

Set the color of surfaces.

symmetry_faces(*args, **kwargs)

Set the color of symmetric faces.

traction_faces(*args, **kwargs)

Set the color of traction faces.

user_color(*args, **kwargs)

Explicitly set color of display zone.

wall_faces(*args, **kwargs)

Set the color of 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)#

Determine whether to skip labels in the colopmap scale automatically.

axis_faces(*args, **kwargs)#

Set the color of axisymmetric faces.

background(*args, **kwargs)#

Set 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.
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.

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.

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.

color_by_type(*args, **kwargs)#

Determine whether to color meshes by type or by surface (ID).

far_field_faces(*args, **kwargs)#

Set the color of far field faces.

foreground(*args, **kwargs)#

Set the foreground (text and window frame) color.

free_surface_faces(*args, **kwargs)#

Set the color of free-surface faces.

graphics_color_theme(*args, **kwargs)#

Enter the graphics color theme menu.

inlet_faces(*args, **kwargs)#

Set the color of inlet faces.

interface_faces(*args, **kwargs)#

Set the color of mesh Interfaces.

interior_faces(*args, **kwargs)#

Set the color of interior faces.

internal_faces(*args, **kwargs)#

Set the color of internal interface faces.

list(*args, **kwargs)#

List available colors.

outlet_faces(*args, **kwargs)#

Set the color of outlet faces.

overset_faces(*args, **kwargs)#

Set the color of overset faces.

periodic_faces(*args, **kwargs)#

Set the color of periodic faces.

rans_les_interface_faces(*args, **kwargs)#

Set the color of RANS/LES interface faces.

reset_colors(*args, **kwargs)#

Reset individual mesh surface colors to the defaults.

reset_user_colors(*args, **kwargs)#

Reset all user colors.

show_user_colors(*args, **kwargs)#

List currently defined user colors.

skip_label(*args, **kwargs)#

Set the number of labels to be skipped in the colopmap scale.

surface(*args, **kwargs)#

Set the color of surfaces.

symmetry_faces(*args, **kwargs)#

Set the color of symmetric faces.

traction_faces(*args, **kwargs)#

Set the color of traction faces.

user_color(*args, **kwargs)#

Explicitly set color of display zone.

wall_faces(*args, **kwargs)#

Set the color of wall faces.

class contours(path, service)#

Bases: TUIMenu

Enters the contour options menu.

Methods:

auto_range(*args, **kwargs)

Enables/disables auto-computation of the contour range.

clip_to_range(*args, **kwargs)

Turns the clip to range option for filled contours on/off.

coloring(*args, **kwargs)

Specifies whether contours are displayed in bands or with smooth transitions.

filled_contours(*args, **kwargs)

Turns the filled contours option on/off (deselects line-contours?).

global_range(*args, **kwargs)

Turns the global range for contours on/off.

line_contours(*args, **kwargs)

Turns the line contours option on/off (deselects filled-contours?).

log_scale(*args, **kwargs)

Specifies a decimal or logarithmic color scale for contours.

n_contour(*args, **kwargs)

Sets the number of contour levels.

node_values(*args, **kwargs)

Sets the option to use scalar field at nodes when computing the contours.

render_mesh(*args, **kwargs)

Determines whether or not to render the mesh on top of contours, vectors, and so on.

surfaces(*args, **kwargs)

Sets the surfaces on which contours are drawn.
auto_range(*args, **kwargs)#

Enables/disables auto-computation of the contour range.

clip_to_range(*args, **kwargs)#

Turns the clip to range option for filled contours on/off.

coloring(*args, **kwargs)#

Specifies whether contours are displayed in bands or with smooth transitions. Note that you can only display smooth contours if node-values are enabled.

filled_contours(*args, **kwargs)#

Turns the filled contours option on/off (deselects line-contours?).

global_range(*args, **kwargs)#

Turns the global range for contours on/off.

line_contours(*args, **kwargs)#

Turns the line contours option on/off (deselects filled-contours?).

log_scale(*args, **kwargs)#

Specifies a decimal or logarithmic color scale for contours.

n_contour(*args, **kwargs)#

Sets the number of contour levels.

node_values(*args, **kwargs)#

Sets the option to use scalar field at nodes when computing the contours.

render_mesh(*args, **kwargs)#

Determines whether or not to render the mesh on top of contours, vectors, and so on.

surfaces(*args, **kwargs)#

Sets the surfaces on which contours are drawn. You can include a wildcard (*) within the surface names.

duplicate_node_display(*args, **kwargs)#

Set flag to remove duplicate nodes in mesh display.

element_shrink(*args, **kwargs)#

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

filled_mesh(*args, **kwargs)#

Determines whether the meshes are drawn as wireframe or solid.

class lights(path, service)#

Bases: TUIMenu

Enter the lights menu.

Methods:

headlight_on(*args, **kwargs)

Turn the light that moves with the camera on or off.

lighting_interpolation(*args, **kwargs)

Set lighting interpolation method.

lights_on(*args, **kwargs)

Turn all active lighting on/off.

set_ambient_color(*args, **kwargs)

Set the ambient light color for the scene.

set_light(*args, **kwargs)

Add or modify a directional, colored light.
headlight_on(*args, **kwargs)#

Turn the light that moves with the camera on or off.

lighting_interpolation(*args, **kwargs)#

Set lighting interpolation method.

lights_on(*args, **kwargs)#

Turn all active lighting on/off.

set_ambient_color(*args, **kwargs)#

Set the ambient light color for the scene.

set_light(*args, **kwargs)#

Add or modify a directional, colored light.

line_weight(*args, **kwargs)#

Set the line-weight factor for the window.

marker_size(*args, **kwargs)#

Sets the size of markers used to represent points.

marker_symbol(*args, **kwargs)#

Sets the type of markers used to represent points.

mesh_display_configuration(*args, **kwargs)#

Changes the default mesh display. If set tomeshing, it draws the mesh on edges and faces of the outline surfaces, colored by their zone ID with lighting enabled. If set tosolution, it draws the mesh on edges and faces of the outline surfaces, colored by their zone type with lighting enabled. If set to post-processing, it draws the object outline with lighting disabled. If set toclassic, it draws the mesh on all edges of the outline surfaces. This only applies for 3D cases.

mesh_level(*args, **kwargs)#

Sets coarse mesh level to be drawn.

mesh_partitions(*args, **kwargs)#

Enables/disables option to draw mesh partition boundaries.

mesh_surfaces(*args, **kwargs)#

Sets surface IDs to be drawn as meshes. You can include a wildcard (*) within the surface names.

mesh_zones(*args, **kwargs)#

Sets zone IDs to be drawn as meshes.

mirror_zones(*args, **kwargs)#

Sets the zones about which the domain is mirrored (symmetry planes).

n_stream_func(*args, **kwargs)#

Sets number of iterations used in computing stream function.

nodewt_based_interp(*args, **kwargs)#

Disables/enables the use of node weights for node-based gradients in postprocessing.

overlays(*args, **kwargs)#

Enable/disable overlays.

class particle_tracks(path, service)#

Bases: TUIMenu

Enters the particle-tracks menu to set parameters for display of particle tracks.

Methods:

arrow_scale(*args, **kwargs)

Sets the scale factor for arrows drawn on particle tracks.

arrow_space(*args, **kwargs)

Sets the spacing factor for arrows drawn on particle tracks.

coarsen_factor(*args, **kwargs)

Sets the coarsening factor for particle tracks.

display(*args, **kwargs)

Determines whether particle tracks shall be displayed or only tracked.

history_filename(*args, **kwargs)

Specifies the name of the particle history file.

line_width(*args, **kwargs)

Sets the width for particle track.

marker_size(*args, **kwargs)

Sets the size of markers used to represent particle tracks.

particle_skip(*args, **kwargs)

Specifies how many particle tracks should be displayed.

radius(*args, **kwargs)

Sets the radius for particle track (ribbon/cylinder only) cross-section.

report_default_variables(*args, **kwargs)

Sets the report variables to default.

report_to(*args, **kwargs)

Specifies the destination for the report (console, file, none).

report_type(*args, **kwargs)

Sets the report type for particle tracks.

report_variables(*args, **kwargs)

Sets the report variables.

sphere_attrib(*args, **kwargs)

Specifies the size and number of slices to be used in drawing spheres.

style(*args, **kwargs)

Sets the display style for particle track (line/ribbon/cylinder/sphere).

track_single_particle_stream(*args, **kwargs)

Specifies the stream ID to be tracked.

twist_factor(*args, **kwargs)

Sets the scale factor for twisting (ribbons only).

Classes:

filter_settings(path, service)

Set filter for particle display.

sphere_settings(path, service)

Provide sphere specific input.

vector_settings(path, service)

Set vector specific input.
arrow_scale(*args, **kwargs)#

Sets the scale factor for arrows drawn on particle tracks.

arrow_space(*args, **kwargs)#

Sets the spacing factor for arrows drawn on particle tracks.

coarsen_factor(*args, **kwargs)#

Sets the coarsening factor for particle tracks.

display(*args, **kwargs)#

Determines whether particle tracks shall be displayed or only tracked.

class filter_settings(path, service)#

Bases: TUIMenu

Set filter for particle display.

Methods:

enable_filtering(*args, **kwargs)

Specifies whether particle display is filtered.

filter_variable(*args, **kwargs)

Selects a variable used for filtering of particles.

inside(*args, **kwargs)

Specifies whether filter variable must be inside min/max to be displayed (else outside min/max).

maximum(*args, **kwargs)

Specifies the upper bound for the filter variable.

minimum(*args, **kwargs)

Specifies the lower bound for the filter variable.
enable_filtering(*args, **kwargs)#

Specifies whether particle display is filtered.

filter_variable(*args, **kwargs)#

Selects a variable used for filtering of particles.

inside(*args, **kwargs)#

Specifies whether filter variable must be inside min/max to be displayed (else outside min/max).

maximum(*args, **kwargs)#

Specifies the upper bound for the filter variable.

minimum(*args, **kwargs)#

Specifies the lower bound for the filter variable.

history_filename(*args, **kwargs)#

Specifies the name of the particle history file.

line_width(*args, **kwargs)#

Sets the width for particle track.

marker_size(*args, **kwargs)#

Sets the size of markers used to represent particle tracks.

particle_skip(*args, **kwargs)#

Specifies how many particle tracks should be displayed.

radius(*args, **kwargs)#

Sets the radius for particle track (ribbon/cylinder only) cross-section.

report_default_variables(*args, **kwargs)#

Sets the report variables to default.

report_to(*args, **kwargs)#

Specifies the destination for the report (console, file, none).

report_type(*args, **kwargs)#

Sets the report type for particle tracks.

report_variables(*args, **kwargs)#

Sets the report variables.

sphere_attrib(*args, **kwargs)#

Specifies the size and number of slices to be used in drawing spheres.

class sphere_settings(path, service)#

Bases: TUIMenu

Provide sphere specific input.

Methods:

auto_range(*args, **kwargs)

Specifies whether displayed spheres should include auto range of variable to size spheres.

diameter(*args, **kwargs)

Diameter of the spheres whenvary-diameter is disabled.

maximum(*args, **kwargs)

Sets the maximum value of the sphere to be displayed.

minimum(*args, **kwargs)

Sets the minimum value of the sphere to be displayed.

scale_factor(*args, **kwargs)

Specifies a scale factor to enlarge/reduce the size of spheres.

size_variable(*args, **kwargs)

Selects a particle variable to size the spheres.

smooth_parameter(*args, **kwargs)

Specifies number of slices to be used in drawing spheres.

vary_diameter(*args, **kwargs)

Specifies whether the spheres can vary with another variable.
auto_range(*args, **kwargs)#

Specifies whether displayed spheres should include auto range of variable to size spheres.

diameter(*args, **kwargs)#

Diameter of the spheres whenvary-diameter is disabled.

maximum(*args, **kwargs)#

Sets the maximum value of the sphere to be displayed.

minimum(*args, **kwargs)#

Sets the minimum value of the sphere to be displayed.

scale_factor(*args, **kwargs)#

Specifies a scale factor to enlarge/reduce the size of spheres.

size_variable(*args, **kwargs)#

Selects a particle variable to size the spheres.

smooth_parameter(*args, **kwargs)#

Specifies number of slices to be used in drawing spheres.

vary_diameter(*args, **kwargs)#

Specifies whether the spheres can vary with another variable.

style(*args, **kwargs)#

Sets the display style for particle track (line/ribbon/cylinder/sphere).

track_single_particle_stream(*args, **kwargs)#

Specifies the stream ID to be tracked.

twist_factor(*args, **kwargs)#

Sets the scale factor for twisting (ribbons only).

class vector_settings(path, service)#

Bases: TUIMenu

Set vector specific input.

Methods:

color_variable(*args, **kwargs)

Specifies whether the vectors should be colored by variable specified in /display/particle-track/particle-track (if false use a constant color).

constant_color(*args, **kwargs)

Specifies a constant color for the vectors.

length_to_head_ratio(*args, **kwargs)

Specifies ratio of length to head for vectors and length to diameter for cylinders.

length_variable(*args, **kwargs)

Specifies whether the displayed vectors have length varying with another variable.

scale_factor(*args, **kwargs)

Specifies a scale factor to enlarge/reduce the length of vectors.

style(*args, **kwargs)

Enables and sets the display style for particle vectors (none/vector/centered-vector/centered-cylinder).

vector_length(*args, **kwargs)

Specifies the length of constant vectors.

vector_length_variable(*args, **kwargs)

Selects a particle variable to specify the length of vectors.

vector_variable(*args, **kwargs)

Selects a particle vector function to specify vector direction.
color_variable(*args, **kwargs)#

Specifies whether the vectors should be colored by variable specified in /display/particle-track/particle-track (if false use a constant color).

constant_color(*args, **kwargs)#

Specifies a constant color for the vectors.

length_to_head_ratio(*args, **kwargs)#

Specifies ratio of length to head for vectors and length to diameter for cylinders.

length_variable(*args, **kwargs)#

Specifies whether the displayed vectors have length varying with another variable.

scale_factor(*args, **kwargs)#

Specifies a scale factor to enlarge/reduce the length of vectors.

style(*args, **kwargs)#

Enables and sets the display style for particle vectors (none/vector/centered-vector/centered-cylinder).

vector_length(*args, **kwargs)#

Specifies the length of constant vectors.

vector_length_variable(*args, **kwargs)#

Selects a particle variable to specify the length of vectors.

vector_variable(*args, **kwargs)#

Selects a particle vector function to specify vector direction.

class path_lines(path, service)#

Bases: TUIMenu

Sets parameters for display of pathlines.

Methods:

arrow_scale(*args, **kwargs)

Sets the scale factor for arrows drawn on pathlines.

arrow_space(*args, **kwargs)

Sets the spacing factor for arrows drawn on pathlines.

display_steps(*args, **kwargs)

Sets the display stepping for pathlines.

error_control(*args, **kwargs)

Sets error control during pathline computation.

line_width(*args, **kwargs)

Sets the width for pathlines.

marker_size(*args, **kwargs)

Sets the marker size for particle drawing.

maximum_error(*args, **kwargs)

Sets the maximum error allowed while computing the pathlines.

maximum_steps(*args, **kwargs)

Sets the maximum number of steps to take for pathlines.

radius(*args, **kwargs)

Sets the radius for pathline (ribbons/cylinder only) cross-section.

relative_pathlines(*args, **kwargs)

Enables/disables the tracking of pathlines in a relative coordinate system.

reverse(*args, **kwargs)

Sets direction of path tracking.

sphere_attrib(*args, **kwargs)

Specifies the size and number of slices to be used in drawing spheres.

step_size(*args, **kwargs)

Sets the step length between particle positions for pathlines.

style(*args, **kwargs)

Selects the pathline style (line, point, ribbon, triangle, cylinder).

track_in_phase(*args, **kwargs)

Selects the phase in which particle pathlines will be computed (Multiphase Eulerian Model only).

twist_factor(*args, **kwargs)

Sets the scale factor for twisting (ribbons only).
arrow_scale(*args, **kwargs)#

Sets the scale factor for arrows drawn on pathlines.

arrow_space(*args, **kwargs)#

Sets the spacing factor for arrows drawn on pathlines.

display_steps(*args, **kwargs)#

Sets the display stepping for pathlines.

error_control(*args, **kwargs)#

Sets error control during pathline computation.

line_width(*args, **kwargs)#

Sets the width for pathlines.

marker_size(*args, **kwargs)#

Sets the marker size for particle drawing.

maximum_error(*args, **kwargs)#

Sets the maximum error allowed while computing the pathlines.

maximum_steps(*args, **kwargs)#

Sets the maximum number of steps to take for pathlines.

radius(*args, **kwargs)#

Sets the radius for pathline (ribbons/cylinder only) cross-section.

relative_pathlines(*args, **kwargs)#

Enables/disables the tracking of pathlines in a relative coordinate system.

reverse(*args, **kwargs)#

Sets direction of path tracking.

sphere_attrib(*args, **kwargs)#

Specifies the size and number of slices to be used in drawing spheres.

step_size(*args, **kwargs)#

Sets the step length between particle positions for pathlines.

style(*args, **kwargs)#

Selects the pathline style (line, point, ribbon, triangle, cylinder).

track_in_phase(*args, **kwargs)#

Selects the phase in which particle pathlines will be computed (Multiphase Eulerian Model only).

twist_factor(*args, **kwargs)#

Sets the scale factor for twisting (ribbons only).

periodic_instancing(*args, **kwargs)#

Sets the number of periodic repetitions.

class picture(path, service)#

Bases: TUIMenu

Enter the hardcopy/save-picture options menu.

Classes:

color_mode(path, service)

Enter the hardcopy color mode menu.

driver(path, service)

Enter the set hardcopy driver menu.

Methods:

dpi(*args, **kwargs)

Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height.

invert_background(*args, **kwargs)

Use a white background when the picture is saved.

jpeg_hardcopy_quality(*args, **kwargs)

To set jpeg hardcopy quality.

landscape(*args, **kwargs)

Plot hardcopies in landscape or portrait orientation.

preview(*args, **kwargs)

Display a preview image of a hardcopy.

set_standard_resolution(*args, **kwargs)

Select from pre-defined resolution list.

use_window_resolution(*args, **kwargs)

Use the currently active window's resolution for hardcopy (ignores the x-resolution and y-resolution in this case).

x_resolution(*args, **kwargs)

Set the width of raster-formatted images in pixels (0 implies current window size).

y_resolution(*args, **kwargs)

Set the height of raster-formatted images in pixels (0 implies current window size).
class color_mode(path, service)#

Bases: TUIMenu

Enter the hardcopy color mode menu.

Methods:

color(*args, **kwargs)

Plot hardcopies in color.

gray_scale(*args, **kwargs)

Convert color to grayscale for hardcopy.

list(*args, **kwargs)

Display the current hardcopy color mode.

mono_chrome(*args, **kwargs)

Convert color to monochrome (black and white) for hardcopy.
color(*args, **kwargs)#

Plot hardcopies in color.

gray_scale(*args, **kwargs)#

Convert color to grayscale for hardcopy.

list(*args, **kwargs)#

Display the current hardcopy color mode.

mono_chrome(*args, **kwargs)#

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

dpi(*args, **kwargs)#

Set the DPI for EPS and Postscript files, specifies the resolution in dots per inch (DPI) instead of setting the width and height.

class driver(path, service)#

Bases: TUIMenu

Enter the set hardcopy driver menu.

Methods:

avz(*args, **kwargs)

Use AVZ output for hardcopies.

dump_window(*args, **kwargs)

Set the command used to dump the graphics window to a file.

eps(*args, **kwargs)

Produce encapsulated PostScript (EPS) output for hardcopies.

glb(*args, **kwargs)

Use GLB output for hardcopies.

hsf(*args, **kwargs)

Use HSF output for hardcopies.

jpeg(*args, **kwargs)

Produce JPEG output for hardcopies.

list(*args, **kwargs)

List the current hardcopy driver.

options(*args, **kwargs)

Set the hardcopy options.

png(*args, **kwargs)

Use PNG output for hardcopies.

post_script(*args, **kwargs)

Produce PostScript output for hardcopies.

ppm(*args, **kwargs)

Produce PPM output for hardcopies.

tiff(*args, **kwargs)

Use TIFF output for hardcopies.

vrml(*args, **kwargs)

Use VRML output for hardcopies.

Classes:

post_format(path, service)

Enter the PostScript driver format menu.
avz(*args, **kwargs)#

Use AVZ output for hardcopies.

dump_window(*args, **kwargs)#

Set the command used to dump the graphics window to a file.

eps(*args, **kwargs)#

Produce encapsulated PostScript (EPS) output for hardcopies.

glb(*args, **kwargs)#

Use GLB output for hardcopies.

hsf(*args, **kwargs)#

Use HSF output for hardcopies.

jpeg(*args, **kwargs)#

Produce JPEG output for hardcopies.

list(*args, **kwargs)#

List the current hardcopy driver.

options(*args, **kwargs)#

Set the hardcopy options. Available options are: “no gamma correction”, disables gamma correction of colors, “physical size = (width,height)”, where width and height are the actual measurements of the printable area of the page in centimeters. “subscreen = (left,right,bottom,top)”, where left,right, bottom, and top are numbers in [-1,1] describing a subwindow on the page in which to place the hardcopy. The options may be combined by separating them with commas.

png(*args, **kwargs)#

Use PNG output for hardcopies.

class post_format(path, service)#

Bases: TUIMenu

Enter the PostScript driver format menu.

Methods:

fast_raster(*args, **kwargs)

Use the new raster format.

raster(*args, **kwargs)

Use the original raster format.

rle_raster(*args, **kwargs)

Use the run-length encoded raster format.

vector(*args, **kwargs)

Use vector format.
fast_raster(*args, **kwargs)#

Use the new raster format.

raster(*args, **kwargs)#

Use the original raster format.

rle_raster(*args, **kwargs)#

Use the run-length encoded raster format.

vector(*args, **kwargs)#

Use vector format.

post_script(*args, **kwargs)#

Produce PostScript output for hardcopies.

ppm(*args, **kwargs)#

Produce PPM output for hardcopies.

tiff(*args, **kwargs)#

Use TIFF output for hardcopies.

vrml(*args, **kwargs)#

Use VRML output for hardcopies.

invert_background(*args, **kwargs)#

Use a white background when the picture is saved.

jpeg_hardcopy_quality(*args, **kwargs)#

To set jpeg hardcopy quality.

landscape(*args, **kwargs)#

Plot hardcopies in landscape or portrait orientation.

preview(*args, **kwargs)#

Display a preview image of a hardcopy.

set_standard_resolution(*args, **kwargs)#

Select from pre-defined resolution list.

use_window_resolution(*args, **kwargs)#

Use the currently active window’s resolution for hardcopy (ignores the x-resolution and y-resolution in this case).

x_resolution(*args, **kwargs)#

Set the width of raster-formatted images in pixels (0 implies current window size).

y_resolution(*args, **kwargs)#

Set the height of raster-formatted images in pixels (0 implies current window size).

proximity_zones(*args, **kwargs)#

Sets zones to be used for boundary cell distance and boundary proximity.

render_mesh(*args, **kwargs)#

Enables/disables rendering the mesh on top of contours, vectors, and so on.

class rendering_options(path, service)#

Bases: TUIMenu

Enter the rendering options menu.

Methods:

animation_option(*args, **kwargs)

Using Wireframe / All option during animation.

auto_spin(*args, **kwargs)

Enable/disable mouse view rotations to continue to spin the display after the button is released.

color_map_alignment(*args, **kwargs)

Set the color bar alignment.

device_info(*args, **kwargs)

List information for the graphics device.

double_buffering(*args, **kwargs)

Enable/disable double-buffering.

driver(*args, **kwargs)

Change the current graphics driver.

face_displacement(*args, **kwargs)

Set face displacement value in Z-buffer units along the Camera Z-axis.

help_text_color(*args, **kwargs)

Set the color of screen help text.

hidden_surface_method(*args, **kwargs)

Specify the method to perform hidden line and hidden surface rendering.

hidden_surfaces(*args, **kwargs)

Enable/disable hidden surface removal.

outer_face_cull(*args, **kwargs)

Enable/disable discarding outer faces during display.

set_rendering_options(*args, **kwargs)

Set the rendering options.

show_colormap(*args, **kwargs)

Enable/Disable colormap.

surface_edge_visibility(*args, **kwargs)

Set edge visibility flags for surfaces.
animation_option(*args, **kwargs)#

Using Wireframe / All option during animation.

auto_spin(*args, **kwargs)#

Enable/disable mouse view rotations to continue to spin the display after the button is released.

color_map_alignment(*args, **kwargs)#

Set the color bar alignment.

device_info(*args, **kwargs)#

List information for the graphics device.

double_buffering(*args, **kwargs)#

Enable/disable double-buffering.

driver(*args, **kwargs)#

Change the current graphics driver.

face_displacement(*args, **kwargs)#

Set face displacement value in Z-buffer units along the Camera Z-axis.

help_text_color(*args, **kwargs)#

Set the color of screen help text.

hidden_surface_method(*args, **kwargs)#

Specify the method to perform hidden line and hidden surface rendering.

hidden_surfaces(*args, **kwargs)#

Enable/disable hidden surface removal.

outer_face_cull(*args, **kwargs)#

Enable/disable discarding outer faces during display.

set_rendering_options(*args, **kwargs)#

Set the rendering options.

show_colormap(*args, **kwargs)#

Enable/Disable colormap.

surface_edge_visibility(*args, **kwargs)#

Set edge visibility flags for surfaces.

reset_graphics(*args, **kwargs)#

Reset the graphics system.

class titles(path, service)#

Bases: TUIMenu

Set problem title.

Methods:

left_bottom(*args, **kwargs)

Set the title text for left bottom in title segment.

left_top(*args, **kwargs)

Set the title text for left top in title segment.

right_bottom(*args, **kwargs)

Set the title text for right bottom in title segment.

right_middle(*args, **kwargs)

Set the title text for right middle in title segment.

right_top(*args, **kwargs)

Set the title text for right top in title segment.
left_bottom(*args, **kwargs)#

Set the title text for left bottom in title segment.

left_top(*args, **kwargs)#

Set the title text for left top in title segment.

right_bottom(*args, **kwargs)#

Set the title text for right bottom in title segment.

right_middle(*args, **kwargs)#

Set the title text for right middle in title segment.

right_top(*args, **kwargs)#

Set the title text for right top in title segment.

class velocity_vectors(path, service)#

Bases: TUIMenu

Enters the menu to set parameters for display of velocity vectors.

Methods:

auto_scale(*args, **kwargs)

Auto-scales all vectors so that vector overlap is minimal.

color(*args, **kwargs)

Sets the color of all velocity vectors to the color specified.

color_levels(*args, **kwargs)

Sets the number of colors used from the colormap.

component_x(*args, **kwargs)

Sets the option to use only the component of the velocity vectors during display.

component_y(*args, **kwargs)

Sets the option to use only the component of the velocity vectors during display.

component_z(*args, **kwargs)

Sets the option to use only the component of the velocity vectors during display.

constant_length(*args, **kwargs)

Sets the option to draw velocity vectors of constant length.

global_range(*args, **kwargs)

Turns global range for vectors on/off.

in_plane(*args, **kwargs)

Toggles the display of velocity vector components in the plane of the surface selected for display.

log_scale(*args, **kwargs)

Toggles whether color scale is logarithmic or linear.

node_values(*args, **kwargs)

Enables/disables the plotting of node values.

relative(*args, **kwargs)

Toggles the display of relative velocity vectors.

render_mesh(*args, **kwargs)

Enables/disables rendering the mesh on top of contours, vectors, and so on.

scale(*args, **kwargs)

Sets the value by which the vector length will be scaled.

scale_head(*args, **kwargs)

Sets the value by which the vector head will be scaled.

style(*args, **kwargs)

Specifies the vector style that will be used when the vectors are displayed.

surfaces(*args, **kwargs)

Sets surfaces on which vectors are drawn.
auto_scale(*args, **kwargs)#

Auto-scales all vectors so that vector overlap is minimal.

color(*args, **kwargs)#

Sets the color of all velocity vectors to the color specified. The color scale is ignored. This is useful when overlaying a vector plot over a contour plot.

color_levels(*args, **kwargs)#

Sets the number of colors used from the colormap.

component_x(*args, **kwargs)#

Sets the option to use only the component of the velocity vectors during display.

component_y(*args, **kwargs)#

Sets the option to use only the component of the velocity vectors during display.

component_z(*args, **kwargs)#

Sets the option to use only the component of the velocity vectors during display.

constant_length(*args, **kwargs)#

Sets the option to draw velocity vectors of constant length. This shows only the direction of the velocity vectors.

global_range(*args, **kwargs)#

Turns global range for vectors on/off.

in_plane(*args, **kwargs)#

Toggles the display of velocity vector components in the plane of the surface selected for display.

log_scale(*args, **kwargs)#

Toggles whether color scale is logarithmic or linear.

node_values(*args, **kwargs)#

Enables/disables the plotting of node values. Cell values will be plotted if “no”.

relative(*args, **kwargs)#

Toggles the display of relative velocity vectors.

render_mesh(*args, **kwargs)#

Enables/disables rendering the mesh on top of contours, vectors, and so on.

scale(*args, **kwargs)#

Sets the value by which the vector length will be scaled.

scale_head(*args, **kwargs)#

Sets the value by which the vector head will be scaled.

style(*args, **kwargs)#

Specifies the vector style that will be used when the vectors are displayed. You can choose from:3d arrow,3d arrowhead, cone,filled-arrow, arrow,harpoon, or headless.

surfaces(*args, **kwargs)#

Sets surfaces on which vectors are drawn. You can include a wildcard (*) within the surface names.

class windows(path, service)#

Bases: TUIMenu

Enter the window options menu.

Methods:

aspect_ratio(*args, **kwargs)

Sets the aspect ratio of the active window.

logo(*args, **kwargs)

.

logo_color(*args, **kwargs)

.

ruler(*args, **kwargs)

Turns the ruler on/off.

Classes:

axes(path, service)

Enters the axes window options menu.

main(path, service)

Enters the main view window options menu.

scale(path, service)

Enters the color scale window options menu.

text(path, service)

Enters the text window options menu.

video(path, service)

Contains options for modifying a video.

xy(path, service)

Enters the XY plot window options menu.
aspect_ratio(*args, **kwargs)#

Sets the aspect ratio of the active window.

class axes(path, service)#

Bases: TUIMenu

Enters the axes window options menu.

Methods:

border(*args, **kwargs)

Sets whether or not to draw a border around the axes window.

bottom(*args, **kwargs)

Sets the bottom boundary of the axes window.

clear(*args, **kwargs)

Sets the transparency of the axes window.

right(*args, **kwargs)

Sets the right boundary of the axes window.

visible(*args, **kwargs)

Controls the visibility of the axes window.
border(*args, **kwargs)#

Sets whether or not to draw a border around the axes window.

bottom(*args, **kwargs)#

Sets the bottom boundary of the axes window.

clear(*args, **kwargs)#

Sets the transparency of the axes window.

right(*args, **kwargs)#

Sets the right boundary of the axes window.

visible(*args, **kwargs)#

Controls the visibility of the axes window.

.

logo_color(*args, **kwargs)#

.

class main(path, service)#

Bases: TUIMenu

Enters the main view window options menu.

Methods:

border(*args, **kwargs)

Sets whether or not to draw a border around the main viewing window.

bottom(*args, **kwargs)

Sets the bottom boundary of the main viewing window.

left(*args, **kwargs)

Sets the left boundary of the main viewing window.

right(*args, **kwargs)

Sets the right boundary of the main viewing window.

top(*args, **kwargs)

Sets the top boundary of the main viewing window.

visible(*args, **kwargs)

Controls the visibility of the main viewing window.
border(*args, **kwargs)#

Sets whether or not to draw a border around the main viewing window.

bottom(*args, **kwargs)#

Sets the bottom boundary of the main viewing window.

left(*args, **kwargs)#

Sets the left boundary of the main viewing window.

right(*args, **kwargs)#

Sets the right boundary of the main viewing window.

top(*args, **kwargs)#

Sets the top boundary of the main viewing window.

visible(*args, **kwargs)#

Controls the visibility of the main viewing window.

ruler(*args, **kwargs)#

Turns the ruler on/off. Note that if you are running Fluent in 3D, then the view must be set toorthographic.

class scale(path, service)#

Bases: TUIMenu

Enters the color scale window options menu.

Methods:

border(*args, **kwargs)

Sets whether or not to draw a border around the color scale window.

bottom(*args, **kwargs)

Sets the bottom boundary of the color scale window.

clear(*args, **kwargs)

Sets the transparency of the color scale window.

font_size(*args, **kwargs)

Sets the font size of the color scale window.

format(*args, **kwargs)

Sets the number format of the color scale window (for example, percentage0.2e).

left(*args, **kwargs)

Sets the left boundary of the color scale window.

margin(*args, **kwargs)

Sets the margin of the color scale window.

right(*args, **kwargs)

Sets the right boundary of the color scale window.

top(*args, **kwargs)

Sets the top boundary of the color scale window.

visible(*args, **kwargs)

Controls the visibility of the color scale window.
border(*args, **kwargs)#

Sets whether or not to draw a border around the color scale window.

bottom(*args, **kwargs)#

Sets the bottom boundary of the color scale window.

clear(*args, **kwargs)#

Sets the transparency of the color scale window.

font_size(*args, **kwargs)#

Sets the font size of the color scale window.

format(*args, **kwargs)#

Sets the number format of the color scale window (for example, percentage0.2e).

left(*args, **kwargs)#

Sets the left boundary of the color scale window.

margin(*args, **kwargs)#

Sets the margin of the color scale window.

right(*args, **kwargs)#

Sets the right boundary of the color scale window.

top(*args, **kwargs)#

Sets the top boundary of the color scale window.

visible(*args, **kwargs)#

Controls the visibility of the color scale window.

class text(path, service)#

Bases: TUIMenu

Enters the text window options menu.

Methods:

alignment(*args, **kwargs)

.

application(*args, **kwargs)

Shows or hides the application name in the picture.

border(*args, **kwargs)

Sets whether or not to draw a border around the text window.

bottom(*args, **kwargs)

Sets the bottom boundary of the text window.

clear(*args, **kwargs)

Enables/disables the transparency of the text window.

company(*args, **kwargs)

Shows or hides the company name in the picture.

date(*args, **kwargs)

Shows or hides the date in the picture.

left(*args, **kwargs)

Sets the left boundary of the text window.

right(*args, **kwargs)

Sets the right boundary of the text window.

top(*args, **kwargs)

Sets the top boundary of the text window.

visible(*args, **kwargs)

Controls the visibility of the text window.
alignment(*args, **kwargs)#

.

application(*args, **kwargs)#

Shows or hides the application name in the picture.

border(*args, **kwargs)#

Sets whether or not to draw a border around the text window.

bottom(*args, **kwargs)#

Sets the bottom boundary of the text window.

clear(*args, **kwargs)#

Enables/disables the transparency of the text window.

company(*args, **kwargs)#

Shows or hides the company name in the picture.

date(*args, **kwargs)#

Shows or hides the date in the picture.

left(*args, **kwargs)#

Sets the left boundary of the text window.

right(*args, **kwargs)#

Sets the right boundary of the text window.

top(*args, **kwargs)#

Sets the top boundary of the text window.

visible(*args, **kwargs)#

Controls the visibility of the text window.

class video(path, service)#

Bases: TUIMenu

Contains options for modifying a video. This menu is not relevant for the meshing mode.

Methods:

background(*args, **kwargs)

Sets the background color of the graphics window.

color_filter(*args, **kwargs)

Sets the video color filter.

foreground(*args, **kwargs)

Sets the foreground (text) color of the graphics window.

on(*args, **kwargs)

Enables or disables the video picture settings.

pixel_size(*args, **kwargs)

Sets the window size in pixels.
background(*args, **kwargs)#

Sets the background color of the graphics window. The color is specified as a string of three comma-separated numbers between 0 and 1, representing red, green, and blue. For example, to change the background from black (default) to gray, you would enter “.5,.5,.5” after selecting the background command.

color_filter(*args, **kwargs)#

Sets the video color filter. For example, to change the color filter from its default setting to PAL video with a saturation of 80percentage and a brightness of 90percentage, you would enter “video=pal,sat=.8,gain=.9” after selecting the color-filter command.

foreground(*args, **kwargs)#

Sets the foreground (text) color of the graphics window. The color is specified as a string of three comma-separated numbers between 0 and 1, representing red, green, and blue. For example, to change the foreground from white (default) to gray, you would enter “.5,.5,.5” after selecting the foreground command.

on(*args, **kwargs)#

Enables or disables the video picture settings.

pixel_size(*args, **kwargs)#

Sets the window size in pixels.

class xy(path, service)#

Bases: TUIMenu

Enters the XY plot window options menu.

Methods:

border(*args, **kwargs)

Sets whether or not to draw a border around the XY plot window.

bottom(*args, **kwargs)

Sets the bottom boundary of the XY plot window.

left(*args, **kwargs)

Sets the left boundary of the XY plot window.

right(*args, **kwargs)

Sets the right boundary of the XY plot window.

top(*args, **kwargs)

Sets the top boundary of the XY plot window.

visible(*args, **kwargs)

Controls the visibility of the XY plot window.
border(*args, **kwargs)#

Sets whether or not to draw a border around the XY plot window.

bottom(*args, **kwargs)#

Sets the bottom boundary of the XY plot window.

left(*args, **kwargs)#

Sets the left boundary of the XY plot window.

right(*args, **kwargs)#

Sets the right boundary of the XY plot window.

top(*args, **kwargs)#

Sets the top boundary of the XY plot window.

visible(*args, **kwargs)#

Controls the visibility of the XY plot window.

zero_angle_dir(*args, **kwargs)#

Sets the vector having zero angular coordinates.

set_list_tree_separator(*args, **kwargs)#

Set the separator character for list tree.

set_window(*args, **kwargs)#

Sets a “user” graphics window to be the active window. User windows are specified by number (1-50), with the associated number corresponding to the order, left-to-right, that the windows were created in.

set_window_by_name(*args, **kwargs)#

Sets the specified graphics window as active. The graphics windows specified using this command are “reserved” windows, that is, residual monitors, report plots, and animation definitions. The name will match the name you provided when creating the object (report plots and animation definitions).

class surface(path, service)#

Bases: TUIMenu

Enters the data surface-manipulation menu. For a description of the items in this menu, see surface/.

Methods:

circle_slice(*args, **kwargs)

Extract a circular slice.

closest_point_search(*args, **kwargs)

Enable the point surface algorithm to look for the nearest point instead of reporting a creation failure.

cone_slice(*args, **kwargs)

Extract a cone slice.

create_imprint_surface(*args, **kwargs)

Imprint surface.

delete_surface(*args, **kwargs)

Remove a defined data surface.

edit_surface(*args, **kwargs)

Edit a defined data surface.

ellipsoid_slice(*args, **kwargs)

Extract a ellipsoid slice.

expression_volume(*args, **kwargs)

Create volume with boolean expression.

group_surfaces(*args, **kwargs)

Group a set of surfaces.

iso_clip(*args, **kwargs)

Clip a data surface (surface, curve, or point) between two iso-values.

iso_surface(*args, **kwargs)

Extract an iso-surface (surface, curve, or point) from the curent data field.

line_slice(*args, **kwargs)

Extract a linear slice.

line_surface(*args, **kwargs)

Define a "line" surface by specifying the two endpoint coordinates.

list_surfaces(*args, **kwargs)

List the number of facets in the defined surfaces.

mouse_line(*args, **kwargs)

Define a line surface using the mouse to select two points.

mouse_plane(*args, **kwargs)

Define a plane surface using the mouse to select three points.

mouse_rake(*args, **kwargs)

Define a "rake" surface using the mouse to select the end points.

multiple_iso_surfaces(*args, **kwargs)

Create multiple iso-surfaces from the data field at specified spacing.

multiple_plane_surfaces(*args, **kwargs)

Create multiple plane surfaces at specified spacing.

multiple_zone_surfaces(*args, **kwargs)

Create multiple data surfaces at a time.

partition_surface(*args, **kwargs)

Define a data surface on mesh faces on the partition boundary.

plane(*args, **kwargs)

Create a plane given 3 points bounded by the domain.

plane_slice(*args, **kwargs)

Extract a planar slice.

plane_surface(*args, **kwargs)

Create a plane from a coordinate plane, point and normal, or three points.

point_array(*args, **kwargs)

Extract a rectangular array of data points.

point_surface(*args, **kwargs)

Define a "point" surface by specifying the coordinates.

quadric_slice(*args, **kwargs)

Extract a quadric slice.

rake_surface(*args, **kwargs)

Define a "rake" surface by specifying the end points.

rename_surface(*args, **kwargs)

Rename a defined data surface.

reset_zone_surfaces(*args, **kwargs)

Reset case surface list.

sphere_slice(*args, **kwargs)

Extract a spherical slice.

structural_point_surface(*args, **kwargs)

Define a "structural point" surface by specifying the coordinates.

surface_cells(*args, **kwargs)

Extract all cells intersected by a data surface.

transform_surface(*args, **kwargs)

Transform surface.

ungroup_surface(*args, **kwargs)

Ungroup the surface(if grouped).

zone_surface(*args, **kwargs)

Define a data surface on a mesh zone.

Classes:

post_processing_volume(path, service)

Enter post-processing volume menu.

query(path, service)

Enter surface query menu.
circle_slice(*args, **kwargs)#

Extract a circular slice.

Enable the point surface algorithm to look for the nearest point instead of reporting a creation failure.

cone_slice(*args, **kwargs)#

Extract a cone slice.

create_imprint_surface(*args, **kwargs)#

Imprint surface.

delete_surface(*args, **kwargs)#

Remove a defined data surface.

edit_surface(*args, **kwargs)#

Edit a defined data surface.

ellipsoid_slice(*args, **kwargs)#

Extract a ellipsoid slice.

expression_volume(*args, **kwargs)#

Create volume with boolean expression.

group_surfaces(*args, **kwargs)#

Group a set of surfaces.

iso_clip(*args, **kwargs)#

Clip a data surface (surface, curve, or point) between two iso-values.

iso_surface(*args, **kwargs)#

Extract an iso-surface (surface, curve, or point) from the curent data field.

line_slice(*args, **kwargs)#

Extract a linear slice.

line_surface(*args, **kwargs)#

Define a “line” surface by specifying the two endpoint coordinates.

list_surfaces(*args, **kwargs)#

List the number of facets in the defined surfaces.

mouse_line(*args, **kwargs)#

Define a line surface using the mouse to select two points.

mouse_plane(*args, **kwargs)#

Define a plane surface using the mouse to select three points.

mouse_rake(*args, **kwargs)#

Define a “rake” surface using the mouse to select the end points.

multiple_iso_surfaces(*args, **kwargs)#

Create multiple iso-surfaces from the data field at specified spacing.

multiple_plane_surfaces(*args, **kwargs)#

Create multiple plane surfaces at specified spacing.

multiple_zone_surfaces(*args, **kwargs)#

Create multiple data surfaces at a time.

partition_surface(*args, **kwargs)#

Define a data surface on mesh faces on the partition boundary.

plane(*args, **kwargs)#

Create a plane given 3 points bounded by the domain.

plane_slice(*args, **kwargs)#

Extract a planar slice.

plane_surface(*args, **kwargs)#

Create a plane from a coordinate plane, point and normal, or three points.

point_array(*args, **kwargs)#

Extract a rectangular array of data points.

point_surface(*args, **kwargs)#

Define a “point” surface by specifying the coordinates.

class post_processing_volume(path, service)#

Bases: TUIMenu

Enter post-processing volume menu.

Methods:

create_from_file(*args, **kwargs)

Read post-processing mesh from file.

create_octree(*args, **kwargs)

Create post-processing octree mesh based on current case.
create_from_file(*args, **kwargs)#

Read post-processing mesh from file.

create_octree(*args, **kwargs)#

Create post-processing octree mesh based on current case.

quadric_slice(*args, **kwargs)#

Extract a quadric slice.

class query(path, service)#

Bases: TUIMenu

Enter surface query menu.

Methods:

delete_query(*args, **kwargs)

Delete saved query.

list_named_selection(*args, **kwargs)

List named selection of surface type.

list_queries(*args, **kwargs)

List all saved queries.

list_surfaces(*args, **kwargs)

List surfaces.

named_surface_list(*args, **kwargs)

Create named list of surfaces.
delete_query(*args, **kwargs)#

Delete saved query.

list_named_selection(*args, **kwargs)#

List named selection of surface type.

list_queries(*args, **kwargs)#

List all saved queries.

list_surfaces(*args, **kwargs)#

List surfaces.

named_surface_list(*args, **kwargs)#

Create named list of surfaces.

rake_surface(*args, **kwargs)#

Define a “rake” surface by specifying the end points.

rename_surface(*args, **kwargs)#

Rename a defined data surface.

reset_zone_surfaces(*args, **kwargs)#

Reset case surface list.

sphere_slice(*args, **kwargs)#

Extract a spherical slice.

structural_point_surface(*args, **kwargs)#

Define a “structural point” surface by specifying the coordinates.

surface_cells(*args, **kwargs)#

Extract all cells intersected by a data surface.

transform_surface(*args, **kwargs)#

Transform surface.

ungroup_surface(*args, **kwargs)#

Ungroup the surface(if grouped).

zone_surface(*args, **kwargs)#

Define a data surface on a mesh zone.

surface_cells(*args, **kwargs)#

Draws the cells on the specified surfaces. You can include a wildcard (*) within the surface names.

surface_mesh(*args, **kwargs)#

Draws the mesh defined by the specified surfaces. You can include a wildcard (*) within the surface names.

switch_to_post_processing_volume(*args, **kwargs)#

Switch to post processing volume.

switch_to_primary_volume(*args, **kwargs)#

Switch to primary volume.

update_layout(*args, **kwargs)#

Update the fluent layout.

class update_scene(path, service)#

Bases: TUIMenu

Enter the scene options menu.

Methods:

delete(*args, **kwargs)

Delete selected geometries.

display(*args, **kwargs)

Display selected geometries.

draw_frame(*args, **kwargs)

Enable/disable drawing of the bounding frame.

iso_sweep(*args, **kwargs)

Change iso-sweep values.

overlays(*args, **kwargs)

Enable/disable the overlays option.

pathline(*args, **kwargs)

Change pathline attributes.

select_geometry(*args, **kwargs)

Select geometry to be updated.

set_frame(*args, **kwargs)

Change frame options.

time(*args, **kwargs)

Change time-step value.

transform(*args, **kwargs)

Apply transformation matrix on selected geometries.
delete(*args, **kwargs)#

Delete selected geometries.

display(*args, **kwargs)#

Display selected geometries.

draw_frame(*args, **kwargs)#

Enable/disable drawing of the bounding frame.

iso_sweep(*args, **kwargs)#

Change iso-sweep values.

overlays(*args, **kwargs)#

Enable/disable the overlays option.

pathline(*args, **kwargs)#

Change pathline attributes.

select_geometry(*args, **kwargs)#

Select geometry to be updated.

set_frame(*args, **kwargs)#

Change frame options.

time(*args, **kwargs)#

Change time-step value.

transform(*args, **kwargs)#

Apply transformation matrix on selected geometries.

vector(*args, **kwargs)#

Displays vectors of a space vector variable.

velocity_vector(*args, **kwargs)#

Prompts for a scalar field by which to color the vectors, the minimum and maximum values, and the scale factor, and then draws the velocity vectors.

class view_sync(path, service)#

Bases: TUIMenu

Synchronize window views.

Methods:

add(*args, **kwargs)

Add list of window ids for synchronization.

add_all(*args, **kwargs)

Synchronize all windows.

list(*args, **kwargs)

Print window ids of open windows.

remove(*args, **kwargs)

Remove list of window ids from synchronization.

remove_all(*args, **kwargs)

Unsynchronize all windows.

start(*args, **kwargs)

Start view synchronization.

stop(*args, **kwargs)

Stop view synchronization.
add(*args, **kwargs)#

Add list of window ids for synchronization.

add_all(*args, **kwargs)#

Synchronize all windows.

list(*args, **kwargs)#

Print window ids of open windows.

remove(*args, **kwargs)#

Remove list of window ids from synchronization.

remove_all(*args, **kwargs)#

Unsynchronize all windows.

start(*args, **kwargs)#

Start view synchronization.

stop(*args, **kwargs)#

Stop view synchronization.

class views(path, service)#

Bases: TUIMenu

Enter the view manipulation menu.

Methods:

auto_scale(*args, **kwargs)

Scales and centers the current scene without changing its orientation.

default_view(*args, **kwargs)

Resets the view to front and center.

delete_view(*args, **kwargs)

Deletes a particular view from the list of stored views.

last_view(*args, **kwargs)

Returns to the camera position before the last manipulation.

list_views(*args, **kwargs)

Lists all predefined and saved views.

next_view(*args, **kwargs)

.

read_views(*args, **kwargs)

Reads views from an external view file.

restore_view(*args, **kwargs)

Sets the current view to one of the stored views.

save_view(*args, **kwargs)

Saves the currently displayed view into the list of stored views.

write_views(*args, **kwargs)

Writes views to an external view file.

Classes:

camera(path, service)

Contains commands to set the camera options.

display_states(path, service)

.
auto_scale(*args, **kwargs)#

Scales and centers the current scene without changing its orientation.

class camera(path, service)#

Bases: TUIMenu

Contains commands to set the camera options.

Methods:

dolly_camera(*args, **kwargs)

Enables you to move the camera left, right, up, down, in, and out.

field(*args, **kwargs)

Enables you to set the field of view (width and height) of the scene.

orbit_camera(*args, **kwargs)

Enables you to move the camera around the target.

pan_camera(*args, **kwargs)

Gives you the effect of sweeping the camera across the scene.

position(*args, **kwargs)

Sets the camera position.

projection(*args, **kwargs)

Lets you switch between perspective and orthographic views.

roll_camera(*args, **kwargs)

Lets you adjust the camera up-vector.

target(*args, **kwargs)

Sets the point the camera will look at.

up_vector(*args, **kwargs)

Sets the camera up-vector.

zoom_camera(*args, **kwargs)

Adjusts the camera’s field of view.
dolly_camera(*args, **kwargs)#

Enables you to move the camera left, right, up, down, in, and out.

field(*args, **kwargs)#

Enables you to set the field of view (width and height) of the scene.

orbit_camera(*args, **kwargs)#

Enables you to move the camera around the target. Gives the effect of circling around the target.

pan_camera(*args, **kwargs)#

Gives you the effect of sweeping the camera across the scene. The camera remains at its position but its target changes.

position(*args, **kwargs)#

Sets the camera position.

projection(*args, **kwargs)#

Lets you switch between perspective and orthographic views.

roll_camera(*args, **kwargs)#

Lets you adjust the camera up-vector.

target(*args, **kwargs)#

Sets the point the camera will look at.

up_vector(*args, **kwargs)#

Sets the camera up-vector.

zoom_camera(*args, **kwargs)#

Adjusts the camera’s field of view. This operation is similar to dollying the camera in or out of the scene. Dollying causes objects in front to move past you. Zooming changes the perspective effect in the scene (and can be disconcerting).

default_view(*args, **kwargs)#

Resets the view to front and center.

delete_view(*args, **kwargs)#

Deletes a particular view from the list of stored views.

class display_states(path, service)#

Bases: TUIMenu

.

Methods:

copy(*args, **kwargs)

.

delete(*args, **kwargs)

Delete object.

edit(*args, **kwargs)

Edit display-states object.

list(*args, **kwargs)

.

new(*args, **kwargs)

Create a new display-states object.

read(*args, **kwargs)

.

rename(*args, **kwargs)

Rename object.

restore_state(*args, **kwargs)

.

use_active(*args, **kwargs)

.

write(*args, **kwargs)

.
copy(*args, **kwargs)#

.

delete(*args, **kwargs)#

Delete object.

edit(*args, **kwargs)#

Edit display-states object.

list(*args, **kwargs)#

.

new(*args, **kwargs)#

Create a new display-states object.

read(*args, **kwargs)#

.

rename(*args, **kwargs)#

Rename object.

restore_state(*args, **kwargs)#

.

use_active(*args, **kwargs)#

.

write(*args, **kwargs)#

.

last_view(*args, **kwargs)#

Returns to the camera position before the last manipulation.

list_views(*args, **kwargs)#

Lists all predefined and saved views.

next_view(*args, **kwargs)#

.

read_views(*args, **kwargs)#

Reads views from an external view file.

restore_view(*args, **kwargs)#

Sets the current view to one of the stored views.

save_view(*args, **kwargs)#

Saves the currently displayed view into the list of stored views.

write_views(*args, **kwargs)#

Writes views to an external view file.

zone_mesh(*args, **kwargs)#

Draws the mesh defined by specified face zones. Zone names can be indicated using wildcards (*).