preferences#

class ansys.fluent.core.meshing.tui_231.main_menu.preferences(path, service)#

Bases: TUIMenu

Set preferences.

Classes:

appearance(path, service)

Enter the menu for preferences covering appearance.

general(path, service)

Enter the menu for general preferences.

gpuapp(path, service)

.

graphics(path, service)

Enter the menu for preferences covering appearance.

mat_pro_app(path, service)

.

meshing_workflow(path, service)

Enter the menu for preferences covering the Fluent Meshing workflows.

navigation(path, service)

Enter the menu for controlling navigation in ANSYS Fluent.

parametric_study(path, service)

.

simulation(path, service)

.

turbo_workflow(path, service)

.

class appearance(path, service)#

Bases: TUIMenu

Enter the menu for preferences covering appearance.

Classes:

ansys_logo(path, service)

Enter the menu for controlling Ansys logo visibility.

charts(path, service)

Enter the menu for controlling the display of 2D charts/plots.

selections(path, service)

Enters the menu for controlling selections in the graphics window.

Methods:

application_font_size(*args, **kwargs)

.

axis_triad(*args, **kwargs)

Enable or disable the visibility of the axis triad in the graphics window.

color_theme(*args, **kwargs)

Specify a color theme for the appearance of ANSYS Fluent.

completer(*args, **kwargs)

Enable/disable the console automatic-completer, which suggests available commands as you type in the console.

custom_title_bar(*args, **kwargs)

.

default_view(*args, **kwargs)

.

graphics_background_color1(*args, **kwargs)

Controls the primary background color of the graphics window.

graphics_background_color2(*args, **kwargs)

Controls the secondary background color when the style is set as a gradient.

graphics_background_style(*args, **kwargs)

Specify whether the background color is uniform or if there is a gradient.

graphics_color_theme(*args, **kwargs)

.

graphics_default_manual_face_color(*args, ...)

.

graphics_default_manual_node_color(*args, ...)

.

graphics_edge_color(*args, **kwargs)

.

graphics_foreground_color(*args, **kwargs)

Specify the color of graphics window text.

graphics_partition_boundary_color(*args, ...)

.

graphics_surface_color(*args, **kwargs)

.

graphics_title_window_framecolor(*args, **kwargs)

.

graphics_view(*args, **kwargs)

Specify whether the default view is orthographic or perspective.

graphics_wall_face_color(*args, **kwargs)

Set the default face color for when the mesh is displayed.

group_by_tree_view(*args, **kwargs)

Specify how boundary conditions are grouped in the tree.

model_color_scheme(*args, **kwargs)

.

number_of_files_recently_used(*args, **kwargs)

Controls how many recently-used files are listed in the File ribbon tab and the Fluent Launcher.

number_of_pastel_colors(*args, **kwargs)

.

pastel_color_saturation(*args, **kwargs)

.

pastel_color_value(*args, **kwargs)

.

quick_property_view(*args, **kwargs)

Enables/Disables the "quick-edit" properties panels that appear when you select a boundary in the graphics windows.

ruler(*args, **kwargs)

Adds or removes the ruler from the graphics window.

show_enabled_models(*args, **kwargs)

.

show_interface_children_zone(*args, **kwargs)

Enable/disable the showing of the non-overlapping zones and interior zones associated with one-to-one mesh interfaces under Setup / Boundary Conditions (under their zone types) in the outline view tree.

show_model_edges(*args, **kwargs)

Enable/disable whether mesh edges are shown in a mesh display.

solution_mode_edge_color_in_meshing_mode(...)

.

surface_emissivity(*args, **kwargs)

.

surface_specularity(*args, **kwargs)

Specify the specularity of all surfaces except those included in contour plots.

surface_specularity_for_contours(*args, **kwargs)

.

titles(*args, **kwargs)

Enable/disable the display of solver information in the graphics window.

titles_border_offset(*args, **kwargs)

.

Bases: TUIMenu

Enter the menu for controlling Ansys logo visibility.

Methods:

color(*args, **kwargs)

Specify whether the Ansys logo is white or black.

visible(*args, **kwargs)

Enable or disable the visibility of the Ansys logo in the graphics window.

color(*args, **kwargs)#

Specify whether the Ansys logo is white or black.

visible(*args, **kwargs)#

Enable or disable the visibility of the Ansys logo in the graphics window.

application_font_size(*args, **kwargs)#

.

axis_triad(*args, **kwargs)#

Enable or disable the visibility of the axis triad in the graphics window.

class charts(path, service)#

Bases: TUIMenu

Enter the menu for controlling the display of 2D charts/plots.

Methods:

curve_colors(*args, **kwargs)

Specify the initial set of default colors for the rendering of curves.

enable_open_glfor_modern_plots(*args, **kwargs)

.

legend_alignment(*args, **kwargs)

.

legend_visibility(*args, **kwargs)

.

modern_plots_enabled(*args, **kwargs)

Enables enhanced plots, which is a beta feature.

modern_plots_points_threshold(*args, **kwargs)

.

plots_behavior(*args, **kwargs)

.

print_plot_data(*args, **kwargs)

.

print_residuals_data(*args, **kwargs)

.

threshold(*args, **kwargs)

.

tooltip_interpolation(*args, **kwargs)

.

Classes:

font(path, service)

.

text_color(path, service)

.

curve_colors(*args, **kwargs)#

Specify the initial set of default colors for the rendering of curves. Note that changing this setting requires any plots to be replotted before you see the effect of the new setting.

enable_open_glfor_modern_plots(*args, **kwargs)#

.

class font(path, service)#

Bases: TUIMenu

.

Methods:

axes(*args, **kwargs)

.

axes_titles(*args, **kwargs)

.

legend(*args, **kwargs)

.

title(*args, **kwargs)

.

axes(*args, **kwargs)#

.

axes_titles(*args, **kwargs)#

.

legend(*args, **kwargs)#

.

title(*args, **kwargs)#

.

legend_alignment(*args, **kwargs)#

.

legend_visibility(*args, **kwargs)#

.

modern_plots_enabled(*args, **kwargs)#

Enables enhanced plots, which is a beta feature. Enabling this feature exposes new fields (all beta functionality).

modern_plots_points_threshold(*args, **kwargs)#

.

plots_behavior(*args, **kwargs)#

.

print_plot_data(*args, **kwargs)#

.

print_residuals_data(*args, **kwargs)#

.

class text_color(path, service)#

Bases: TUIMenu

.

Methods:

axes(*args, **kwargs)

.

axes_titles(*args, **kwargs)

.

legend(*args, **kwargs)

.

title(*args, **kwargs)

.

axes(*args, **kwargs)#

.

axes_titles(*args, **kwargs)#

.

legend(*args, **kwargs)#

.

title(*args, **kwargs)#

.

threshold(*args, **kwargs)#

.

tooltip_interpolation(*args, **kwargs)#

.

color_theme(*args, **kwargs)#

Specify a color theme for the appearance of ANSYS Fluent.

completer(*args, **kwargs)#

Enable/disable the console automatic-completer, which suggests available commands as you type in the console.

custom_title_bar(*args, **kwargs)#

.

default_view(*args, **kwargs)#

.

graphics_background_color1(*args, **kwargs)#

Controls the primary background color of the graphics window.

graphics_background_color2(*args, **kwargs)#

Controls the secondary background color when the style is set as a gradient.

graphics_background_style(*args, **kwargs)#

Specify whether the background color is uniform or if there is a gradient.

graphics_color_theme(*args, **kwargs)#

.

graphics_default_manual_face_color(*args, **kwargs)#

.

graphics_default_manual_node_color(*args, **kwargs)#

.

graphics_edge_color(*args, **kwargs)#

.

graphics_foreground_color(*args, **kwargs)#

Specify the color of graphics window text.

graphics_partition_boundary_color(*args, **kwargs)#

.

graphics_surface_color(*args, **kwargs)#

.

graphics_title_window_framecolor(*args, **kwargs)#

.

graphics_view(*args, **kwargs)#

Specify whether the default view is orthographic or perspective.

graphics_wall_face_color(*args, **kwargs)#

Set the default face color for when the mesh is displayed.

group_by_tree_view(*args, **kwargs)#

Specify how boundary conditions are grouped in the tree.

model_color_scheme(*args, **kwargs)#

.

number_of_files_recently_used(*args, **kwargs)#

Controls how many recently-used files are listed in the File ribbon tab and the Fluent Launcher.

number_of_pastel_colors(*args, **kwargs)#

.

pastel_color_saturation(*args, **kwargs)#

.

pastel_color_value(*args, **kwargs)#

.

quick_property_view(*args, **kwargs)#

Enables/Disables the “quick-edit” properties panels that appear when you select a boundary in the graphics windows.

ruler(*args, **kwargs)#

Adds or removes the ruler from the graphics window. Note that you must be in orthographic view for the ruler to be visible in the graphics window.

class selections(path, service)#

Bases: TUIMenu

Enters the menu for controlling selections in the graphics window.

Methods:

general_displacement(*args, **kwargs)

.

highlight_edge_color(*args, **kwargs)

Specifies the color used to highlight edges when the Hover-Over Highlight feature is enabled (mouse-over-highlight-enabled).

highlight_edge_weight(*args, **kwargs)

Specifies the thickness of the edge highlights when the Hover-Over Highlight feature is enabled (mouse-over-highlight-enabled).

highlight_face_color(*args, **kwargs)

Specify which color indicates that a face is selected.

highlight_gloss(*args, **kwargs)

.

highlight_specular_component(*args, **kwargs)

.

highlight_transparency(*args, **kwargs)

Specify the transparency of the coloring on a selected surface.

mouse_hover_probe_values_enabled(*args, **kwargs)

.

mouse_over_highlight_enabled(*args, **kwargs)

Enable/disable the highlighted outline of a surface when hovered-over.

probe_tooltip_hide_delay_timer(*args, **kwargs)

.

probe_tooltip_show_delay_timer(*args, **kwargs)

.

general_displacement(*args, **kwargs)#

.

highlight_edge_color(*args, **kwargs)#

Specifies the color used to highlight edges when the Hover-Over Highlight feature is enabled (mouse-over-highlight-enabled).

highlight_edge_weight(*args, **kwargs)#

Specifies the thickness of the edge highlights when the Hover-Over Highlight feature is enabled (mouse-over-highlight-enabled).

highlight_face_color(*args, **kwargs)#

Specify which color indicates that a face is selected.

highlight_gloss(*args, **kwargs)#

.

highlight_specular_component(*args, **kwargs)#

.

highlight_transparency(*args, **kwargs)#

Specify the transparency of the coloring on a selected surface. 0.1 is fully opaque and 1 is fully transparent.

mouse_hover_probe_values_enabled(*args, **kwargs)#

.

mouse_over_highlight_enabled(*args, **kwargs)#

Enable/disable the highlighted outline of a surface when hovered-over. Note that objects must be redisplayed after changing this setting before the new setting is visible.

probe_tooltip_hide_delay_timer(*args, **kwargs)#

.

probe_tooltip_show_delay_timer(*args, **kwargs)#

.

show_enabled_models(*args, **kwargs)#

.

show_interface_children_zone(*args, **kwargs)#

Enable/disable the showing of the non-overlapping zones and interior zones associated with one-to-one mesh interfaces under Setup / Boundary Conditions (under their zone types) in the outline view tree.

show_model_edges(*args, **kwargs)#

Enable/disable whether mesh edges are shown in a mesh display.

solution_mode_edge_color_in_meshing_mode(*args, **kwargs)#

.

surface_emissivity(*args, **kwargs)#

.

surface_specularity(*args, **kwargs)#

Specify the specularity of all surfaces except those included in contour plots. Sepecularity is the reflectiveness of a surface; higher values (closer to 1) equate to a more reflective surface.

surface_specularity_for_contours(*args, **kwargs)#

.

titles(*args, **kwargs)#

Enable/disable the display of solver information in the graphics window.

titles_border_offset(*args, **kwargs)#

.

class general(path, service)#

Bases: TUIMenu

Enter the menu for general preferences.

Methods:

advanced_partition(*args, **kwargs)

.

automatic_transcript(*args, **kwargs)

Enable/disable the automatic creation of a transcript file for each ANSYS Fluent session.

default_ioformat(*args, **kwargs)

.

dock_editor(*args, **kwargs)

.

enable_parametric_study(*args, **kwargs)

.

flow_model(*args, **kwargs)

.

idle_timeout(*args, **kwargs)

Specify the default file format for saving case and data files.

initial_physics_volume_definitions(*args, ...)

.

key_behavioral_changes_message(*args, **kwargs)

.

laplace_auto_partition_default(*args, **kwargs)

.

qaservice_message(*args, **kwargs)

.

utlcreate_physics_on_mode_change(*args, **kwargs)

.

utlmode(*args, **kwargs)

.

advanced_partition(*args, **kwargs)#

.

automatic_transcript(*args, **kwargs)#

Enable/disable the automatic creation of a transcript file for each ANSYS Fluent session.

default_ioformat(*args, **kwargs)#

.

dock_editor(*args, **kwargs)#

.

enable_parametric_study(*args, **kwargs)#

.

flow_model(*args, **kwargs)#

.

idle_timeout(*args, **kwargs)#

Specify the default file format for saving case and data files.

initial_physics_volume_definitions(*args, **kwargs)#

.

key_behavioral_changes_message(*args, **kwargs)#

.

laplace_auto_partition_default(*args, **kwargs)#

.

qaservice_message(*args, **kwargs)#

.

utlcreate_physics_on_mode_change(*args, **kwargs)#

.

utlmode(*args, **kwargs)#

.

class gpuapp(path, service)#

Bases: TUIMenu

.

Methods:

alpha_features(*args, **kwargs)

.

alpha_features(*args, **kwargs)#

.

class graphics(path, service)#

Bases: TUIMenu

Enter the menu for preferences covering appearance.

Methods:

animation_option(*args, **kwargs)

Specify whether the entire model or just a wireframe is shown during manipulations in the graphics window.

double_buffering(*args, **kwargs)

Enable/disable double-buffering, which reduces screen flicker, but may use more memory on some machines.

enable_non_object_based_workflow(*args, **kwargs)

.

event_poll_interval(*args, **kwargs)

.

event_poll_timeout(*args, **kwargs)

.

force_key_frame_animation_markers_to_off(...)

.

graphics_window_line_width(*args, **kwargs)

Specify the thickness of lines that appear in the graphics window.

graphics_window_point_symbol(*args, **kwargs)

Specify the symbol used for indicating points in the graphics window (like the points in an XY plot).

hidden_surface_removal_method(*args, **kwargs)

Specify the method for removing hidden surfaces.

higher_resolution_graphics_window_line_width(...)

.

lower_resolution_graphics_window_line_width(...)

.

marker_drawing_mode(*args, **kwargs)

.

max_graphics_text_size(*args, **kwargs)

.

min_graphics_text_size(*args, **kwargs)

.

plot_legend_margin(*args, **kwargs)

.

point_tool_size(*args, **kwargs)

Specify the size of the point tool (10-100).

remove_partition_lines(*args, **kwargs)

.

remove_partition_lines_tolerance(*args, **kwargs)

.

rotation_centerpoint_visible(*args, **kwargs)

.

scroll_wheel_event_end_timer(*args, **kwargs)

.

set_camera_normal_to_surface_increments(...)

.

show_hidden_lines(*args, **kwargs)

.

show_hidden_surfaces(*args, **kwargs)

Enable/disable the display of hidden surfaces.

switch_to_open_glfor_remote_visualization(...)

.

test_use_external_function(*args, **kwargs)

.

text_window_line_width(*args, **kwargs)

.

Classes:

boundary_markers(path, service)

Enter the boundary markers menu.

colormap_settings(path, service)

Enter the colormap settings menu.

embedded_windows(path, service)

.

export_video_settings(path, service)

.

graphics_effects(path, service)

Enter the graphics effects menu.

hardcopy_settings(path, service)

Enter the menu for saving picture settings.

lighting(path, service)

Enter the lighting menu.

manage_hoops_memory(path, service)

.

material_effects(path, service)

.

meshing_mode(path, service)

Enter the menu for meshing-specific graphics settings.

performance(path, service)

Enter the menu for selecting the predefined graphics effects settings.

transparency(path, service)

.

vector_settings(path, service)

.

animation_option(*args, **kwargs)#

Specify whether the entire model or just a wireframe is shown during manipulations in the graphics window.

class boundary_markers(path, service)#

Bases: TUIMenu

Enter the boundary markers menu.

Methods:

color_option(*args, **kwargs)

Specify whether boundary markers are a fixed color or if they match the color of the surface they are identifying.

enabled(*args, **kwargs)

Enable/disable boundary marker display.

exclude_from_bounding(*args, **kwargs)

.

inlet_color(*args, **kwargs)

Specify the color of the inlet boundary markers.

marker_fraction(*args, **kwargs)

Specify marker density factor (0.1-1).

marker_size_limiting_scale_multiplier(*args, ...)

.

markers_limit(*args, **kwargs)

.

outlet_color(*args, **kwargs)

Specify the color of the outlet boundary markers.

scale_marker(*args, **kwargs)

Specify the scale factor for the boundary markers (0.1-10), which controls the overall size of the markers.

show_inlet_markers(*args, **kwargs)

Enable/disable the display of boundary markers for inlets.

show_outlet_markers(*args, **kwargs)

Enable/disable the display of boundary markers for outlets.

color_option(*args, **kwargs)#

Specify whether boundary markers are a fixed color or if they match the color of the surface they are identifying.

enabled(*args, **kwargs)#

Enable/disable boundary marker display.

exclude_from_bounding(*args, **kwargs)#

.

inlet_color(*args, **kwargs)#

Specify the color of the inlet boundary markers.

marker_fraction(*args, **kwargs)#

Specify marker density factor (0.1-1).

marker_size_limiting_scale_multiplier(*args, **kwargs)#

.

markers_limit(*args, **kwargs)#

.

outlet_color(*args, **kwargs)#

Specify the color of the outlet boundary markers.

scale_marker(*args, **kwargs)#

Specify the scale factor for the boundary markers (0.1-10), which controls the overall size of the markers.

show_inlet_markers(*args, **kwargs)#

Enable/disable the display of boundary markers for inlets.

show_outlet_markers(*args, **kwargs)#

Enable/disable the display of boundary markers for outlets.

class colormap_settings(path, service)#

Bases: TUIMenu

Enter the colormap settings menu.

Methods:

alignment(*args, **kwargs)

Specify the default colormap location.

aspect_ratio_when_horizontal(*args, **kwargs)

.

aspect_ratio_when_vertical(*args, **kwargs)

Specify the length vs.

auto_refit_on_resize(*args, **kwargs)

.

automatic_resize(*args, **kwargs)

.

border_style(*args, **kwargs)

Specify how/when the colormap border appears.

colormap(*args, **kwargs)

Choose the default colormap.

isolines_position_offset(*args, **kwargs)

.

labels(*args, **kwargs)

Specify whether there is a label for every colormap value or if some are skipped.

levels(*args, **kwargs)

Specify the default colormap size.

log_scale(*args, **kwargs)

Enable/disable the use of a logarithmic scale for the colormap.

major_length_to_screen_ratio_when_horizontal(...)

.

major_length_to_screen_ratio_when_vertical(...)

Choose the length of the colormap as a fraction of graphics window height, when the colormap is vertical.

margin_from_edge_to_screen_ratio(*args, **kwargs)

.

max_size_scale_factor(*args, **kwargs)

.

min_size_scale_factor(*args, **kwargs)

.

number_format_precision(*args, **kwargs)

Specify the colormap number label precision.

number_format_type(*args, **kwargs)

Specify how colormap numbers are displayed.

preserve_aspect_ratio_for_hardcopy(*args, ...)

.

show_colormap(*args, **kwargs)

Enable/disable the display of colormaps.

skip_value(*args, **kwargs)

Specify how many number labels are skipped in the colormap.

text_behavior(*args, **kwargs)

Specify whether colormap label text automatically scales with the colormap size.

text_font_automatic_horizontal_size(*args, ...)

.

text_font_automatic_size(*args, **kwargs)

.

text_font_automatic_units(*args, **kwargs)

.

text_font_automatic_vertical_size(*args, ...)

Specify the initial font size as a ratio of the colormap overall size, for vertically aligned colormaps.

text_font_fixed_horizontal_size(*args, **kwargs)

.

text_font_fixed_size(*args, **kwargs)

Set the font size for colormap labels.

text_font_fixed_units(*args, **kwargs)

.

text_font_fixed_vertical_size(*args, **kwargs)

.

text_font_name(*args, **kwargs)

.

text_truncation_limit_for_horizontal_colormaps(...)

.

text_truncation_limit_for_vertical_colormaps(...)

.

type(*args, **kwargs)

Specify whether the colormap appearance is smooth or banded.

use_no_sub_windows(*args, **kwargs)

.

alignment(*args, **kwargs)#

Specify the default colormap location.

aspect_ratio_when_horizontal(*args, **kwargs)#

.

aspect_ratio_when_vertical(*args, **kwargs)#

Specify the length vs. width ratio for a vertical colormap, which controls the thickness of the colormap; smaller values mean a thicker colormap.

auto_refit_on_resize(*args, **kwargs)#

.

automatic_resize(*args, **kwargs)#

.

border_style(*args, **kwargs)#

Specify how/when the colormap border appears.

colormap(*args, **kwargs)#

Choose the default colormap.

isolines_position_offset(*args, **kwargs)#

.

labels(*args, **kwargs)#

Specify whether there is a label for every colormap value or if some are skipped.

levels(*args, **kwargs)#

Specify the default colormap size.

log_scale(*args, **kwargs)#

Enable/disable the use of a logarithmic scale for the colormap.

major_length_to_screen_ratio_when_horizontal(*args, **kwargs)#

.

major_length_to_screen_ratio_when_vertical(*args, **kwargs)#

Choose the length of the colormap as a fraction of graphics window height, when the colormap is vertical.

margin_from_edge_to_screen_ratio(*args, **kwargs)#

.

max_size_scale_factor(*args, **kwargs)#

.

min_size_scale_factor(*args, **kwargs)#

.

number_format_precision(*args, **kwargs)#

Specify the colormap number label precision.

number_format_type(*args, **kwargs)#

Specify how colormap numbers are displayed.

preserve_aspect_ratio_for_hardcopy(*args, **kwargs)#

.

show_colormap(*args, **kwargs)#

Enable/disable the display of colormaps.

skip_value(*args, **kwargs)#

Specify how many number labels are skipped in the colormap.

text_behavior(*args, **kwargs)#

Specify whether colormap label text automatically scales with the colormap size.

text_font_automatic_horizontal_size(*args, **kwargs)#

.

text_font_automatic_size(*args, **kwargs)#

.

text_font_automatic_units(*args, **kwargs)#

.

text_font_automatic_vertical_size(*args, **kwargs)#

Specify the initial font size as a ratio of the colormap overall size, for vertically aligned colormaps.

text_font_fixed_horizontal_size(*args, **kwargs)#

.

text_font_fixed_size(*args, **kwargs)#

Set the font size for colormap labels.

text_font_fixed_units(*args, **kwargs)#

.

text_font_fixed_vertical_size(*args, **kwargs)#

.

text_font_name(*args, **kwargs)#

.

text_truncation_limit_for_horizontal_colormaps(*args, **kwargs)#

.

text_truncation_limit_for_vertical_colormaps(*args, **kwargs)#

.

type(*args, **kwargs)#

Specify whether the colormap appearance is smooth or banded.

use_no_sub_windows(*args, **kwargs)#

.

double_buffering(*args, **kwargs)#

Enable/disable double-buffering, which reduces screen flicker, but may use more memory on some machines.

class embedded_windows(path, service)#

Bases: TUIMenu

.

Methods:

default_embedded_mesh_windows_view(*args, ...)

.

default_embedded_windows_view(*args, **kwargs)

.

save_embedded_window_layout(*args, **kwargs)

.

show_border_for_embedded_window(*args, **kwargs)

.

default_embedded_mesh_windows_view(*args, **kwargs)#

.

default_embedded_windows_view(*args, **kwargs)#

.

save_embedded_window_layout(*args, **kwargs)#

.

show_border_for_embedded_window(*args, **kwargs)#

.

enable_non_object_based_workflow(*args, **kwargs)#

.

event_poll_interval(*args, **kwargs)#

.

event_poll_timeout(*args, **kwargs)#

.

class export_video_settings(path, service)#

Bases: TUIMenu

.

Classes:

advanced_video_quality_options(path, service)

.

Methods:

video_format(*args, **kwargs)

.

video_fps(*args, **kwargs)

.

video_quality(*args, **kwargs)

.

video_resoution_x(*args, **kwargs)

.

video_resoution_y(*args, **kwargs)

.

video_scale(*args, **kwargs)

.

video_smooth_scaling(*args, **kwargs)

.

video_use_frame_resolution(*args, **kwargs)

.

class advanced_video_quality_options(path, service)#

Bases: TUIMenu

.

Methods:

bit_rate_quality(*args, **kwargs)

.

bitrate(*args, **kwargs)

.

compression_method(*args, **kwargs)

.

enable_h264(*args, **kwargs)

.

bit_rate_quality(*args, **kwargs)#

.

bitrate(*args, **kwargs)#

.

compression_method(*args, **kwargs)#

.

enable_h264(*args, **kwargs)#

.

video_format(*args, **kwargs)#

.

video_fps(*args, **kwargs)#

.

video_quality(*args, **kwargs)#

.

video_resoution_x(*args, **kwargs)#

.

video_resoution_y(*args, **kwargs)#

.

video_scale(*args, **kwargs)#

.

video_smooth_scaling(*args, **kwargs)#

.

video_use_frame_resolution(*args, **kwargs)#

.

force_key_frame_animation_markers_to_off(*args, **kwargs)#

.

class graphics_effects(path, service)#

Bases: TUIMenu

Enter the graphics effects menu.

Methods:

ambient_occlusion_enabled(*args, **kwargs)

.

ambient_occlusion_quality(*args, **kwargs)

.

ambient_occlusion_strength(*args, **kwargs)

.

anti_aliasing(*args, **kwargs)

Enable/disable the smoothing of lines and text.

bloom_blur(*args, **kwargs)

.

bloom_enabled(*args, **kwargs)

.

bloom_strength(*args, **kwargs)

.

grid_color(*args, **kwargs)

Specify the color of the grid lines when the ground plane grid is shown.

grid_plane_count(*args, **kwargs)

.

grid_plane_enabled(*args, **kwargs)

Enable/disable the display of the ground plane grid.

grid_plane_offset(*args, **kwargs)

Set the grid plane offset from the model as a percentage of the model size.

grid_plane_size_factor(*args, **kwargs)

.

plane_direction(*args, **kwargs)

Specify the direction of the plane for the ground plane grid and reflections.

reflections_enabled(*args, **kwargs)

Enable/disable model reflections (mirror-type reflections).

shadow_map_enabled(*args, **kwargs)

Enable/disable dynamic shadows, which show shadows of geometric entities on other objects based on lighting and object orientation.

show_edge_reflections(*args, **kwargs)

Enable/disable the display of model edges in reflections.

show_marker_reflections(*args, **kwargs)

.

simple_shadows_enabled(*args, **kwargs)

Enable/disable the display of static shadows on the ground plane.

update_after_mouse_release(*args, **kwargs)

Enable/disable the updating of graphics effects as a model is being manipulated in the graphics window.

ambient_occlusion_enabled(*args, **kwargs)#

.

ambient_occlusion_quality(*args, **kwargs)#

.

ambient_occlusion_strength(*args, **kwargs)#

.

anti_aliasing(*args, **kwargs)#

Enable/disable the smoothing of lines and text.

bloom_blur(*args, **kwargs)#

.

bloom_enabled(*args, **kwargs)#

.

bloom_strength(*args, **kwargs)#

.

grid_color(*args, **kwargs)#

Specify the color of the grid lines when the ground plane grid is shown.

grid_plane_count(*args, **kwargs)#

.

grid_plane_enabled(*args, **kwargs)#

Enable/disable the display of the ground plane grid.

grid_plane_offset(*args, **kwargs)#

Set the grid plane offset from the model as a percentage of the model size.

grid_plane_size_factor(*args, **kwargs)#

.

plane_direction(*args, **kwargs)#

Specify the direction of the plane for the ground plane grid and reflections.

reflections_enabled(*args, **kwargs)#

Enable/disable model reflections (mirror-type reflections).

shadow_map_enabled(*args, **kwargs)#

Enable/disable dynamic shadows, which show shadows of geometric entities on other objects based on lighting and object orientation.

show_edge_reflections(*args, **kwargs)#

Enable/disable the display of model edges in reflections. Note that this can negatively affect performance.

show_marker_reflections(*args, **kwargs)#

.

simple_shadows_enabled(*args, **kwargs)#

Enable/disable the display of static shadows on the ground plane.

update_after_mouse_release(*args, **kwargs)#

Enable/disable the updating of graphics effects as a model is being manipulated in the graphics window.

graphics_window_line_width(*args, **kwargs)#

Specify the thickness of lines that appear in the graphics window.

graphics_window_point_symbol(*args, **kwargs)#

Specify the symbol used for indicating points in the graphics window (like the points in an XY plot).

class hardcopy_settings(path, service)#

Bases: TUIMenu

Enter the menu for saving picture settings.

Methods:

export_edges_for_avz(*args, **kwargs)

.

hardcopy_driver(*args, **kwargs)

Specify the default format for saving pictures.

hardcopy_line_width(*args, **kwargs)

Specify the thinkness of lines for saved pictures.

hardware_image_accel(*args, **kwargs)

.

post_script_permission_override(*args, **kwargs)

.

save_embedded_hardcopies_separately(*args, ...)

.

save_embedded_windows_in_hardcopy(*args, ...)

.

transparent_embedded_windows(*args, **kwargs)

.

export_edges_for_avz(*args, **kwargs)#

.

hardcopy_driver(*args, **kwargs)#

Specify the default format for saving pictures.

hardcopy_line_width(*args, **kwargs)#

Specify the thinkness of lines for saved pictures.

hardware_image_accel(*args, **kwargs)#

.

post_script_permission_override(*args, **kwargs)#

.

save_embedded_hardcopies_separately(*args, **kwargs)#

.

save_embedded_windows_in_hardcopy(*args, **kwargs)#

.

transparent_embedded_windows(*args, **kwargs)#

.

hidden_surface_removal_method(*args, **kwargs)#

Specify the method for removing hidden surfaces. These methods vary in speed and quality, depending on your machine.

higher_resolution_graphics_window_line_width(*args, **kwargs)#

.

class lighting(path, service)#

Bases: TUIMenu

Enter the lighting menu.

Methods:

ambient_light_intensity(*args, **kwargs)

.

headlight(*args, **kwargs)

Turn the headlight on or off or set it as automatic.

headlight_intensity(*args, **kwargs)

Specify the intensity of the headlight.

lighting_method(*args, **kwargs)

Specify the default lighting method.

ambient_light_intensity(*args, **kwargs)#

.

headlight(*args, **kwargs)#

Turn the headlight on or off or set it as automatic.

headlight_intensity(*args, **kwargs)#

Specify the intensity of the headlight.

lighting_method(*args, **kwargs)#

Specify the default lighting method.

lower_resolution_graphics_window_line_width(*args, **kwargs)#

.

class manage_hoops_memory(path, service)#

Bases: TUIMenu

.

Methods:

enabled(*args, **kwargs)

.

hsfimport_limit(*args, **kwargs)

.

enabled(*args, **kwargs)#

.

hsfimport_limit(*args, **kwargs)#

.

marker_drawing_mode(*args, **kwargs)#

.

class material_effects(path, service)#

Bases: TUIMenu

.

Methods:

decimation_filter(*args, **kwargs)

.

parameterization_source(*args, **kwargs)

.

tiling_style(*args, **kwargs)

.

decimation_filter(*args, **kwargs)#

.

parameterization_source(*args, **kwargs)#

.

tiling_style(*args, **kwargs)#

.

max_graphics_text_size(*args, **kwargs)#

.

class meshing_mode(path, service)#

Bases: TUIMenu

Enter the menu for meshing-specific graphics settings.

Methods:

graphics_window_display_timeout(*args, **kwargs)

Enable/disable graphics window display timeout.

graphics_window_display_timeout_value(*args, ...)

Specify the graphics window display timeout value.

graphics_window_display_timeout(*args, **kwargs)#

Enable/disable graphics window display timeout.

graphics_window_display_timeout_value(*args, **kwargs)#

Specify the graphics window display timeout value.

min_graphics_text_size(*args, **kwargs)#

.

class performance(path, service)#

Bases: TUIMenu

Enter the menu for selecting the predefined graphics effects settings.

Classes:

fast_display_mode(path, service)

.

minimum_frame_rate(path, service)

Enter the menu for minimum frame-rate settings.

Methods:

optimize_for(*args, **kwargs)

Choose a preset selection for how graphics are displayed.

ratio_of_target_frame_rate_to_classify_heavy_geometry(...)

.

ratio_of_target_frame_rate_to_declassify_heavy_geometry(...)

.

class fast_display_mode(path, service)#

Bases: TUIMenu

.

Methods:

culling(*args, **kwargs)

.

faces_shown(*args, **kwargs)

.

markers_decimation(*args, **kwargs)

.

nodes_shown(*args, **kwargs)

.

perimeter_edges_shown(*args, **kwargs)

.

silhouette_shown(*args, **kwargs)

.

status(*args, **kwargs)

.

transparency(*args, **kwargs)

.

culling(*args, **kwargs)#

.

faces_shown(*args, **kwargs)#

.

markers_decimation(*args, **kwargs)#

.

nodes_shown(*args, **kwargs)#

.

perimeter_edges_shown(*args, **kwargs)#

.

silhouette_shown(*args, **kwargs)#

.

status(*args, **kwargs)#

.

transparency(*args, **kwargs)#

.

class minimum_frame_rate(path, service)#

Bases: TUIMenu

Enter the menu for minimum frame-rate settings.

Methods:

dynamic_adjustment(*args, **kwargs)

Enable/disable dynamic adjustment of quality loss per frame to get to the desired frame rate.

enabled(*args, **kwargs)

Enable/disable minimum frame rate.

fixed_culling_value(*args, **kwargs)

.

maximum_culling_threshold(*args, **kwargs)

With minimum frame rate enabled, Fluent will not cull beyond this number of pixels.

minimum_culling_threshold(*args, **kwargs)

With minimum frame rate enabled, Fluent will cull at least this number of pixels.

target_fps(*args, **kwargs)

Specify the target frames-per-second.

dynamic_adjustment(*args, **kwargs)#

Enable/disable dynamic adjustment of quality loss per frame to get to the desired frame rate.

enabled(*args, **kwargs)#

Enable/disable minimum frame rate.

fixed_culling_value(*args, **kwargs)#

.

maximum_culling_threshold(*args, **kwargs)#

With minimum frame rate enabled, Fluent will not cull beyond this number of pixels.

minimum_culling_threshold(*args, **kwargs)#

With minimum frame rate enabled, Fluent will cull at least this number of pixels.

target_fps(*args, **kwargs)#

Specify the target frames-per-second.

optimize_for(*args, **kwargs)#

Choose a preset selection for how graphics are displayed.

ratio_of_target_frame_rate_to_classify_heavy_geometry(*args, **kwargs)#

.

ratio_of_target_frame_rate_to_declassify_heavy_geometry(*args, **kwargs)#

.

plot_legend_margin(*args, **kwargs)#

.

point_tool_size(*args, **kwargs)#

Specify the size of the point tool (10-100).

remove_partition_lines(*args, **kwargs)#

.

remove_partition_lines_tolerance(*args, **kwargs)#

.

rotation_centerpoint_visible(*args, **kwargs)#

.

scroll_wheel_event_end_timer(*args, **kwargs)#

.

set_camera_normal_to_surface_increments(*args, **kwargs)#

.

show_hidden_lines(*args, **kwargs)#

.

show_hidden_surfaces(*args, **kwargs)#

Enable/disable the display of hidden surfaces.

switch_to_open_glfor_remote_visualization(*args, **kwargs)#

.

test_use_external_function(*args, **kwargs)#

.

text_window_line_width(*args, **kwargs)#

.

class transparency(path, service)#

Bases: TUIMenu

.

Methods:

algorithm_for_modern_drivers(*args, **kwargs)

.

depth_peeling_layers(*args, **kwargs)

.

depth_peeling_preference(*args, **kwargs)

.

quick_moves(*args, **kwargs)

.

zsort_options(*args, **kwargs)

.

algorithm_for_modern_drivers(*args, **kwargs)#

.

depth_peeling_layers(*args, **kwargs)#

.

depth_peeling_preference(*args, **kwargs)#

.

quick_moves(*args, **kwargs)#

.

zsort_options(*args, **kwargs)#

.

class vector_settings(path, service)#

Bases: TUIMenu

.

Methods:

arrow3_dradius1_factor(*args, **kwargs)

.

arrow3_dradius2_factor(*args, **kwargs)

.

arrowhead3_dradius1_factor(*args, **kwargs)

.

line_arrow3_dperpendicular_radius(*args, ...)

.

arrow3_dradius1_factor(*args, **kwargs)#

.

arrow3_dradius2_factor(*args, **kwargs)#

.

arrowhead3_dradius1_factor(*args, **kwargs)#

.

line_arrow3_dperpendicular_radius(*args, **kwargs)#

.

class mat_pro_app(path, service)#

Bases: TUIMenu

.

Methods:

beta_features(*args, **kwargs)

.

focus(*args, **kwargs)

.

warning(*args, **kwargs)

.

beta_features(*args, **kwargs)#

.

focus(*args, **kwargs)#

.

warning(*args, **kwargs)#

.

class meshing_workflow(path, service)#

Bases: TUIMenu

Enter the menu for preferences covering the Fluent Meshing workflows.

Methods:

checkpointing_option(*args, **kwargs)

Specify how Fluent Meshing will save data when you edit a task.

save_checkpoint_files(*args, **kwargs)

Enable/disable the saving of task editing data when writing a mesh file.

temp_folder(*args, **kwargs)

Specify a temporary location to hold generated mesh files.

templates_folder(*args, **kwargs)

.

verbosity(*args, **kwargs)

Enable/disable the printing of additional information and messages in the Console.

Classes:

draw_settings(path, service)

Enter the menu for specifying drawing settings.

checkpointing_option(*args, **kwargs)#

Specify how Fluent Meshing will save data when you edit a task.

class draw_settings(path, service)#

Bases: TUIMenu

Enter the menu for specifying drawing settings.

Methods:

auto_draw(*args, **kwargs)

Enable/disable the automatic display of changes in the graphics window based on the current task.

face_zone_limit(*args, **kwargs)

Specify the cutoff number of face zones, beyond which, Fluent Meshing will not automatically display changes.

facet_limit(*args, **kwargs)

Specify the cutoff number facets, beyond which, Fluent Meshing will not automatically display changes.

auto_draw(*args, **kwargs)#

Enable/disable the automatic display of changes in the graphics window based on the current task.

face_zone_limit(*args, **kwargs)#

Specify the cutoff number of face zones, beyond which, Fluent Meshing will not automatically display changes.

facet_limit(*args, **kwargs)#

Specify the cutoff number facets, beyond which, Fluent Meshing will not automatically display changes.

save_checkpoint_files(*args, **kwargs)#

Enable/disable the saving of task editing data when writing a mesh file.

temp_folder(*args, **kwargs)#

Specify a temporary location to hold generated mesh files. If nothing is specified, Fluent Meshing will write to percentageTEMPpercentage on Windows and to /tmp on Linux.

templates_folder(*args, **kwargs)#

.

verbosity(*args, **kwargs)#

Enable/disable the printing of additional information and messages in the Console.

class navigation(path, service)#

Bases: TUIMenu

Enter the menu for controlling navigation in ANSYS Fluent.

Classes:

mouse_mapping(path, service)

Enable/disable the printing of additional information and messages in the Console.

class mouse_mapping(path, service)#

Bases: TUIMenu

Enable/disable the printing of additional information and messages in the Console.

Classes:

additional(path, service)

Enter the menu for controlling mouse mappings that include a modifier button such as Ctrl and Shift.

basic(path, service)

.

Methods:

mousemaptheme(*args, **kwargs)

.

class additional(path, service)#

Bases: TUIMenu

Enter the menu for controlling mouse mappings that include a modifier button such as Ctrl and Shift.

Methods:

ctrllmbclick(*args, **kwargs)

Specify the action/behavoir for Ctrl + left-mouse-button + click.

ctrllmbdrag(*args, **kwargs)

Specify the action/behavior for Ctrl + left-mouse-button + drag.

ctrlmmbclick(*args, **kwargs)

Specify the action/behavior for Ctrl + middle-mouse-button + click.

ctrlmmbdrag(*args, **kwargs)

Specify the action/behavior for Ctrl + middle-mouse-button + drag.

ctrlrmbclick(*args, **kwargs)

Specify the action/behavior for Ctrl + right-mouse-button + click.

ctrlrmbdrag(*args, **kwargs)

Specify the action/behavior for Ctrl + right-mouse-button + drag.

mouseprobe(*args, **kwargs)

Specify whether the probe action provides a long description or a short description.

mousewheel(*args, **kwargs)

Specify the action/behavior of the mouse-wheel.

mousewheelsensitivity(*args, **kwargs)

Specify the sensitivity of the mouse-wheel (0 is least sensitive, 1 is most sensitive).

reversewheeldirection(*args, **kwargs)

Reverse the behavior of the mouse-wheel.

shiftlmbclick(*args, **kwargs)

Specify the action/behavior for Shift + left-mouse-button + click.

shiftlmbdrag(*args, **kwargs)

Specify the action/behavior for Shift + left-mouse-button + drag.

shiftmmbclick(*args, **kwargs)

Specify the action/behavior for Shift + middle-mouse-button + click.

shiftmmbdrag(*args, **kwargs)

Specify the action/behavior for Shift + middle-mouse-button + drag.

shiftrmbclick(*args, **kwargs)

Specify the action/behavior for Shift + right-mouse-button + click.

shiftrmbdrag(*args, **kwargs)

Specify the action/behavior for Shift + right-mouse-button + drag.

ctrllmbclick(*args, **kwargs)#

Specify the action/behavoir for Ctrl + left-mouse-button + click.

ctrllmbdrag(*args, **kwargs)#

Specify the action/behavior for Ctrl + left-mouse-button + drag.

ctrlmmbclick(*args, **kwargs)#

Specify the action/behavior for Ctrl + middle-mouse-button + click.

ctrlmmbdrag(*args, **kwargs)#

Specify the action/behavior for Ctrl + middle-mouse-button + drag.

ctrlrmbclick(*args, **kwargs)#

Specify the action/behavior for Ctrl + right-mouse-button + click.

ctrlrmbdrag(*args, **kwargs)#

Specify the action/behavior for Ctrl + right-mouse-button + drag.

mouseprobe(*args, **kwargs)#

Specify whether the probe action provides a long description or a short description.

mousewheel(*args, **kwargs)#

Specify the action/behavior of the mouse-wheel.

mousewheelsensitivity(*args, **kwargs)#

Specify the sensitivity of the mouse-wheel (0 is least sensitive, 1 is most sensitive).

reversewheeldirection(*args, **kwargs)#

Reverse the behavior of the mouse-wheel.

shiftlmbclick(*args, **kwargs)#

Specify the action/behavior for Shift + left-mouse-button + click.

shiftlmbdrag(*args, **kwargs)#

Specify the action/behavior for Shift + left-mouse-button + drag.

shiftmmbclick(*args, **kwargs)#

Specify the action/behavior for Shift + middle-mouse-button + click.

shiftmmbdrag(*args, **kwargs)#

Specify the action/behavior for Shift + middle-mouse-button + drag.

shiftrmbclick(*args, **kwargs)#

Specify the action/behavior for Shift + right-mouse-button + click.

shiftrmbdrag(*args, **kwargs)#

Specify the action/behavior for Shift + right-mouse-button + drag.

class basic(path, service)#

Bases: TUIMenu

.

Methods:

lmb(*args, **kwargs)

.

lmbclick(*args, **kwargs)

.

mmb(*args, **kwargs)

.

mmbclick(*args, **kwargs)

.

rmb(*args, **kwargs)

.

rmbclick(*args, **kwargs)

.

lmb(*args, **kwargs)#

.

lmbclick(*args, **kwargs)#

.

mmb(*args, **kwargs)#

.

mmbclick(*args, **kwargs)#

.

rmb(*args, **kwargs)#

.

rmbclick(*args, **kwargs)#

.

mousemaptheme(*args, **kwargs)#

.

class parametric_study(path, service)#

Bases: TUIMenu

.

Classes:

layout_options(path, service)

.

update_options(path, service)

.

class layout_options(path, service)#

Bases: TUIMenu

.

Methods:

current_case_parameters(*args, **kwargs)

.

parametric_study_tree(*args, **kwargs)

.

current_case_parameters(*args, **kwargs)#

.

parametric_study_tree(*args, **kwargs)#

.

class update_options(path, service)#

Bases: TUIMenu

.

Methods:

auto_refresh_time(*args, **kwargs)

.

capture_sim_report_data(*args, **kwargs)

.

enable_auto_refresh(*args, **kwargs)

.

save_project_after_dpupdate(*args, **kwargs)

.

write_data(*args, **kwargs)

.

auto_refresh_time(*args, **kwargs)#

.

capture_sim_report_data(*args, **kwargs)#

.

enable_auto_refresh(*args, **kwargs)#

.

save_project_after_dpupdate(*args, **kwargs)#

.

write_data(*args, **kwargs)#

.

class simulation(path, service)#

Bases: TUIMenu

.

Methods:

flow_model(*args, **kwargs)

.

local_residual_scaling(*args, **kwargs)

.

Classes:

report_definitions(path, service)

Enter the menu for report definition preferences.

flow_model(*args, **kwargs)#

.

local_residual_scaling(*args, **kwargs)#

.

class report_definitions(path, service)#

Bases: TUIMenu

Enter the menu for report definition preferences.

Methods:

automatic_plot_file(*args, **kwargs)

New report definitions will automatically create associated report files and plots.

report_plot_history_data_size(*args, **kwargs)

Specify how many data points are read from the associated report file and plotted in the graphics window.

automatic_plot_file(*args, **kwargs)#

New report definitions will automatically create associated report files and plots.

report_plot_history_data_size(*args, **kwargs)#

Specify how many data points are read from the associated report file and plotted in the graphics window. If the case/data files are already open, read the case and data again, after changing this setting, and re-plot to see the updated report plot.

class turbo_workflow(path, service)#

Bases: TUIMenu

.

Classes:

cell_zone_settings(path, service)

.

face_zone_settings(path, service)

.

graphics_settings(path, service)

.

Methods:

checkpointing_option(*args, **kwargs)

.

save_checkpoint_files(*args, **kwargs)

.

class cell_zone_settings(path, service)#

Bases: TUIMenu

.

Methods:

czsearch_order(*args, **kwargs)

.

rotating(*args, **kwargs)

.

stationary(*args, **kwargs)

.

czsearch_order(*args, **kwargs)#

.

rotating(*args, **kwargs)#

.

stationary(*args, **kwargs)#

.

checkpointing_option(*args, **kwargs)#

.

class face_zone_settings(path, service)#

Bases: TUIMenu

.

Methods:

blade_region(*args, **kwargs)

.

fzsearch_order(*args, **kwargs)

.

hub_region(*args, **kwargs)

.

inlet_region(*args, **kwargs)

.

interior_region(*args, **kwargs)

.

outlet_region(*args, **kwargs)

.

periodic1_region(*args, **kwargs)

.

periodic2_region(*args, **kwargs)

.

shroud_region(*args, **kwargs)

.

symmetry_region(*args, **kwargs)

.

tip1_region(*args, **kwargs)

.

tip2_region(*args, **kwargs)

.

blade_region(*args, **kwargs)#

.

fzsearch_order(*args, **kwargs)#

.

hub_region(*args, **kwargs)#

.

inlet_region(*args, **kwargs)#

.

interior_region(*args, **kwargs)#

.

outlet_region(*args, **kwargs)#

.

periodic1_region(*args, **kwargs)#

.

periodic2_region(*args, **kwargs)#

.

shroud_region(*args, **kwargs)#

.

symmetry_region(*args, **kwargs)#

.

tip1_region(*args, **kwargs)#

.

tip2_region(*args, **kwargs)#

.

class graphics_settings(path, service)#

Bases: TUIMenu

.

Methods:

auto_draw(*args, **kwargs)

.

auto_draw(*args, **kwargs)#

.

save_checkpoint_files(*args, **kwargs)#

.