results#

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

Bases: TUIMenu

Enter results menu.

Classes:

animate(path, service)

Enter the animation menu.

graphics(path, service)

Enter graphics menu.

graphics_window(path, service)

Enter graphics window menu.

plot(path, service)

Enter the XY plot menu.

report(path, service)

Enter the report menu.

surface(path, service)

Enter the data surface manipulation menu.
class animate(path, service)#

Bases: TUIMenu

Enter the animation menu.

Classes:

playback(path, service)

Enter animation playback menu.
class playback(path, service)#

Bases: TUIMenu

Enter animation playback menu.

Methods:

delete(*args, **kwargs)

Delete animation sequence.

play(*args, **kwargs)

Play the selected animation.

read(*args, **kwargs)

Read new animation from file or already-defined animations.

set_custom_frames(*args, **kwargs)

Set custom frames start, end, skip frames for video export.

stored_view(*args, **kwargs)

Play the 3D animation sequence using the view stored in the sequence.

write(*args, **kwargs)

Write animation sequence to the file.

Classes:

video(path, service)

Set options for exporting video file menu.
delete(*args, **kwargs)#

Delete animation sequence.

play(*args, **kwargs)#

Play the selected animation.

read(*args, **kwargs)#

Read new animation from file or already-defined animations.

set_custom_frames(*args, **kwargs)#

Set custom frames start, end, skip frames for video export.

stored_view(*args, **kwargs)#

Play the 3D animation sequence using the view stored in the sequence.

class video(path, service)#

Bases: TUIMenu

Set options for exporting video file menu.

Classes:

advance_quality(path, service)

Advance Quality setting.

Methods:

format(*args, **kwargs)

Set format for exporting video file.

fps(*args, **kwargs)

Set the Frame Per Sec(FPS) for exporting video file.

height(*args, **kwargs)

Set the height for exporting video file.

name(*args, **kwargs)

Exporting video file name.

quality(*args, **kwargs)

Set quality for exporting video file.

scale(*args, **kwargs)

Set scale by which video resolution will expand.

set_standard_resolution(*args, **kwargs)

Select from pre-defined resolution list.

use_original_resolution(*args, **kwargs)

Enable original resolution.

width(*args, **kwargs)

Set the width for exporting video file.
class advance_quality(path, service)#

Bases: TUIMenu

Advance Quality setting.

Methods:

bitrate(*args, **kwargs)

Set video bitrate(kbits/sec) for exporting video file.

bitrate_scale(*args, **kwargs)

Mp4 bitrate scale - Best-64000 High-32000 Medium-16000 Low-8000.

compression_method(*args, **kwargs)

Compression methode for Microsoft AVI movie.

enable_h264(*args, **kwargs)

H264 encoding flag.
bitrate(*args, **kwargs)#

Set video bitrate(kbits/sec) for exporting video file.

bitrate_scale(*args, **kwargs)#

Mp4 bitrate scale - Best-64000 High-32000 Medium-16000 Low-8000.

compression_method(*args, **kwargs)#

Compression methode for Microsoft AVI movie.

enable_h264(*args, **kwargs)#

H264 encoding flag.

format(*args, **kwargs)#

Set format for exporting video file.

fps(*args, **kwargs)#

Set the Frame Per Sec(FPS) for exporting video file.

height(*args, **kwargs)#

Set the height for exporting video file.

name(*args, **kwargs)#

Exporting video file name.

quality(*args, **kwargs)#

Set quality for exporting video file.

scale(*args, **kwargs)#

Set scale by which video resolution will expand.

set_standard_resolution(*args, **kwargs)#

Select from pre-defined resolution list.

use_original_resolution(*args, **kwargs)#

Enable original resolution.

width(*args, **kwargs)#

Set the width for exporting video file.

write(*args, **kwargs)#

Write animation sequence to the file.

class graphics(path, service)#

Bases: TUIMenu

Enter graphics menu.

Methods:

annotate(*args, **kwargs)

Add a text annotation string to the active graphics window.

clear_annotations(*args, **kwargs)

Delete all annotation text.

color_map(*args, **kwargs)

Enter the color-map menu.

hsf_file(*args, **kwargs)

Display hoops stream file data to active graphics window.

Classes:

expert(path, service)

Enter expert menu.

lights(path, service)

Enter the lights menu.

objects(path, service)

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

rendering_options(path, service)

Enter the rendering options menu.

update_scene(path, service)

Enter the scene options menu.
annotate(*args, **kwargs)#

Add a text annotation string to the active graphics window.

clear_annotations(*args, **kwargs)#

Delete all annotation text.

color_map(*args, **kwargs)#

Enter the color-map menu.

class expert(path, service)#

Bases: TUIMenu

Enter expert menu.

Methods:

add_custom_vector(*args, **kwargs)

Add new custom vector definition.

contour(*args, **kwargs)

Display contours of a flow variable.

display_custom_vector(*args, **kwargs)

Display custom vector.

graphics_window_layout(*args, **kwargs)

Arrange the graphics window layout.

mesh(*args, **kwargs)

Display the mesh.

mesh_outline(*args, **kwargs)

Display the mesh boundaries.

mesh_partition_boundary(*args, **kwargs)

Display mesh partition boundaries.

multigrid_coarsening(*args, **kwargs)

Display a coarse mesh level from the last multigrid coarsening.

profile(*args, **kwargs)

Display profiles of a flow variable.

re_render(*args, **kwargs)

Re-render the last contour, profile, or velocity vector plot with updated surfaces, meshes, lights, colormap, rendering options, etc., without recalculating the contour data.

re_scale(*args, **kwargs)

Re-render the last contour, profile, or velocity vector plot with updated scale, surfaces, meshes, lights, colormap, rendering options, etc., without recalculating the field data.

reacting_channel_curves(*args, **kwargs)

Plot/Report the reacting channel variables.

set_list_tree_separator(*args, **kwargs)

Set the separator character for list tree.

surface_cells(*args, **kwargs)

Draw the cells on the specified surfaces.

surface_mesh(*args, **kwargs)

Draw the mesh defined by the specified surfaces.

vector(*args, **kwargs)

Display space vectors.

velocity_vector(*args, **kwargs)

Display velocity vectors.

zone_mesh(*args, **kwargs)

Draw the mesh defined by specified face zones.

Classes:

flamelet_data(path, service)

Display flamelet data.

particle_tracks(path, service)

Enter the particle tracks menu.

path_lines(path, service)

Enter the pathlines menu.

pdf_data(path, service)

Enter the PDF data menu.

set(path, service)

Enter the set menu to set display parameters.
add_custom_vector(*args, **kwargs)#

Add new custom vector definition.

contour(*args, **kwargs)#

Display contours of a flow variable.

display_custom_vector(*args, **kwargs)#

Display custom vector.

class flamelet_data(path, service)#

Bases: TUIMenu

Display flamelet data.

Methods:

carpet_plot(*args, **kwargs)

Enable/disable display of carpet plot of a property.

draw_number_box(*args, **kwargs)

Enable/disable display of the numbers box.

plot_1d_slice(*args, **kwargs)

Enable/disable plot of the 1D-slice.

write_to_file(*args, **kwargs)

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

Enable/disable display of carpet plot of a property.

draw_number_box(*args, **kwargs)#

Enable/disable display of the numbers box.

plot_1d_slice(*args, **kwargs)#

Enable/disable plot of the 1D-slice.

write_to_file(*args, **kwargs)#

Enable/disable writing the 1D-slice to file instead of plot.

graphics_window_layout(*args, **kwargs)#

Arrange the graphics window layout.

mesh(*args, **kwargs)#

Display the mesh.

mesh_outline(*args, **kwargs)#

Display the mesh boundaries.

mesh_partition_boundary(*args, **kwargs)#

Display mesh partition boundaries.

multigrid_coarsening(*args, **kwargs)#

Display a coarse mesh level from the last multigrid coarsening.

class particle_tracks(path, service)#

Bases: TUIMenu

Enter the particle tracks menu.

Methods:

particle_tracks(*args, **kwargs)

Calculate and display particle tracks from defined injections.

plot_write_xy_plot(*args, **kwargs)

Plot or write XY plot of particle tracks.
particle_tracks(*args, **kwargs)#

Calculate and display particle tracks from defined injections.

plot_write_xy_plot(*args, **kwargs)#

Plot or write XY plot of particle tracks.

class path_lines(path, service)#

Bases: TUIMenu

Enter the pathlines menu.

Methods:

path_lines(*args, **kwargs)

Display pathlines from a surface.

plot_write_xy_plot(*args, **kwargs)

Plot or write XY plot of pathline.

write_to_files(*args, **kwargs)

Write Pathlines to a File.
path_lines(*args, **kwargs)#

Display pathlines from a surface.

plot_write_xy_plot(*args, **kwargs)#

Plot or write XY plot of pathline.

write_to_files(*args, **kwargs)#

Write Pathlines to a File.

class pdf_data(path, service)#

Bases: TUIMenu

Enter the PDF data menu.

Methods:

carpet_plot(*args, **kwargs)

Enable/disable the display of a carpet plot of a property.

draw_number_box(*args, **kwargs)

Enable/disable the display of the numbers box.

plot_1d_slice(*args, **kwargs)

Enable/disable a plot of the 1D-slice.

write_to_file(*args, **kwargs)

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

Enable/disable the display of a carpet plot of a property.

draw_number_box(*args, **kwargs)#

Enable/disable the display of the numbers box.

plot_1d_slice(*args, **kwargs)#

Enable/disable a plot of the 1D-slice.

write_to_file(*args, **kwargs)#

Enable/disable writing the 1D-slice to file instead of plot.

profile(*args, **kwargs)#

Display profiles of a flow variable.

re_render(*args, **kwargs)#

Re-render the last contour, profile, or velocity vector plot with updated surfaces, meshes, lights, colormap, rendering options, etc., without recalculating the contour data.

re_scale(*args, **kwargs)#

Re-render the last contour, profile, or velocity vector plot with updated scale, surfaces, meshes, lights, colormap, rendering options, etc., without recalculating the field data.

reacting_channel_curves(*args, **kwargs)#

Plot/Report the reacting channel variables.

class set(path, service)#

Bases: TUIMenu

Enter the set menu to set display parameters.

Methods:

color_map(*args, **kwargs)

Enter the color-map menu.

duplicate_node_display(*args, **kwargs)

Set flag to remove duplicate nodes in mesh display.

element_shrink(*args, **kwargs)

Set percentage to shrink elements.

filled_mesh(*args, **kwargs)

Enable/disable the filled mesh option.

line_weight(*args, **kwargs)

Set the line-weight factor for the window.

marker_size(*args, **kwargs)

Set the size of markers used to represent points.

marker_symbol(*args, **kwargs)

Set the type of markers used to represent points.

mesh_display_configuration(*args, **kwargs)

Set mesh display configuration.

mesh_level(*args, **kwargs)

Set coarse mesh level to be drawn.

mesh_partitions(*args, **kwargs)

Enable/disable drawing of the mesh partition boundaries.

mesh_surfaces(*args, **kwargs)

Set surface IDs to be drawn as mesh.

mesh_zones(*args, **kwargs)

Set zone IDs to be drawn as mesh.

mirror_zones(*args, **kwargs)

Set zones to mirror the domain about.

n_stream_func(*args, **kwargs)

Set the number of iterations used in computing stream function.

nodewt_based_interp(*args, **kwargs)

Use more accurate node-weight based interpolation for postprocessing.

overlays(*args, **kwargs)

Enable/disable overlays.

periodic_instancing(*args, **kwargs)

Set periodic instancing.

proximity_zones(*args, **kwargs)

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

render_mesh(*args, **kwargs)

Enable/disable rendering the mesh on top of contours, vectors, etc.

reset_graphics(*args, **kwargs)

Reset the graphics system.

zero_angle_dir(*args, **kwargs)

Set the vector having zero angular coordinates.

Classes:

colors(path, service)

Enter the color options menu.

contours(path, service)

Enter the contour options menu.

lights(path, service)

Enter the lights menu.

particle_tracks(path, service)

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

path_lines(path, service)

Enter the path-lines menu to set parameters for the 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)

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

windows(path, service)

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

Enter the color-map menu.

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

Enter the contour options menu.

Methods:

auto_range(*args, **kwargs)

Enable/disable auto-computation of range for contours.

clip_to_range(*args, **kwargs)

Enable/disable the clip to range option for filled contours.

coloring(*args, **kwargs)

Select coloring option.

filled_contours(*args, **kwargs)

Enable/disable the filled contour option.

global_range(*args, **kwargs)

Enable/disable the global range for contours option.

line_contours(*args, **kwargs)

Enable/disable the filled contour option.

log_scale(*args, **kwargs)

Enable/disable the use of a log scale.

n_contour(*args, **kwargs)

Set the number of contour levels.

node_values(*args, **kwargs)

Enable/disable the plot of node values.

render_mesh(*args, **kwargs)

Determine whether or not to render the mesh on top of contours, vectors, etc.

surfaces(*args, **kwargs)

Set surfaces to be contoured.
auto_range(*args, **kwargs)#

Enable/disable auto-computation of range for contours.

clip_to_range(*args, **kwargs)#

Enable/disable the clip to range option for filled contours.

coloring(*args, **kwargs)#

Select coloring option.

filled_contours(*args, **kwargs)#

Enable/disable the filled contour option.

global_range(*args, **kwargs)#

Enable/disable the global range for contours option.

line_contours(*args, **kwargs)#

Enable/disable the filled contour option.

log_scale(*args, **kwargs)#

Enable/disable the use of a log scale.

n_contour(*args, **kwargs)#

Set the number of contour levels.

node_values(*args, **kwargs)#

Enable/disable the plot of node values.

render_mesh(*args, **kwargs)#

Determine whether or not to render the mesh on top of contours, vectors, etc.

surfaces(*args, **kwargs)#

Set surfaces to be contoured.

duplicate_node_display(*args, **kwargs)#

Set flag to remove duplicate nodes in mesh display.

element_shrink(*args, **kwargs)#

Set percentage to shrink elements.

filled_mesh(*args, **kwargs)#

Enable/disable the filled mesh option.

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)#

Set the size of markers used to represent points.

marker_symbol(*args, **kwargs)#

Set the type of markers used to represent points.

mesh_display_configuration(*args, **kwargs)#

Set mesh display configuration.

mesh_level(*args, **kwargs)#

Set coarse mesh level to be drawn.

mesh_partitions(*args, **kwargs)#

Enable/disable drawing of the mesh partition boundaries.

mesh_surfaces(*args, **kwargs)#

Set surface IDs to be drawn as mesh.

mesh_zones(*args, **kwargs)#

Set zone IDs to be drawn as mesh.

mirror_zones(*args, **kwargs)#

Set zones to mirror the domain about.

n_stream_func(*args, **kwargs)#

Set the number of iterations used in computing stream function.

nodewt_based_interp(*args, **kwargs)#

Use more accurate node-weight based interpolation for postprocessing.

overlays(*args, **kwargs)#

Enable/disable overlays.

class particle_tracks(path, service)#

Bases: TUIMenu

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

Methods:

arrow_scale(*args, **kwargs)

Set the scale factor for arrows drawn on particle tracks.

arrow_space(*args, **kwargs)

Set the spacing factor for arrows drawn on particle tracks.

coarsen_factor(*args, **kwargs)

Set the particle tracks coarsening factor.

display(*args, **kwargs)

Determine whether particle tracks will be displayed or only tracked.

history_filename(*args, **kwargs)

Specify the name of the particle history file.

line_width(*args, **kwargs)

Set the width for particle track.

marker_size(*args, **kwargs)

Set the marker size for particle drawing.

particle_skip(*args, **kwargs)

Specify how many particle tracks should be displayed.

radius(*args, **kwargs)

Set the radius for particle track (ribbons/cylinder only) cross-section.

report_default_variables(*args, **kwargs)

Set the report variables to default.

report_to(*args, **kwargs)

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

report_type(*args, **kwargs)

Set the report type for particle tracks.

report_variables(*args, **kwargs)

Set the report variables.

sphere_attrib(*args, **kwargs)

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

style(*args, **kwargs)

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

track_single_particle_stream(*args, **kwargs)

Specify the stream ID to be tracked.

twist_factor(*args, **kwargs)

Set 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)#

Set the scale factor for arrows drawn on particle tracks.

arrow_space(*args, **kwargs)#

Set the spacing factor for arrows drawn on particle tracks.

coarsen_factor(*args, **kwargs)#

Set the particle tracks coarsening factor.

display(*args, **kwargs)#

Determine whether particle tracks will be displayed or only tracked.

class filter_settings(path, service)#

Bases: TUIMenu

Set filter for particle display.

Methods:

enable_filtering(*args, **kwargs)

Specify whether particle display is filtered.

filter_variable(*args, **kwargs)

Select a variable used for filtering of particles.

inside(*args, **kwargs)

Specify whether filter variable needs to be inside min/max to be displayed (else outside min/max).

maximum(*args, **kwargs)

Specify the upper bound for the filter variable.

minimum(*args, **kwargs)

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

Specify whether particle display is filtered.

filter_variable(*args, **kwargs)#

Select a variable used for filtering of particles.

inside(*args, **kwargs)#

Specify whether filter variable needs to be inside min/max to be displayed (else outside min/max).

maximum(*args, **kwargs)#

Specify the upper bound for the filter variable.

minimum(*args, **kwargs)#

Specify the lower bound for the filter variable.

history_filename(*args, **kwargs)#

Specify the name of the particle history file.

line_width(*args, **kwargs)#

Set the width for particle track.

marker_size(*args, **kwargs)#

Set the marker size for particle drawing.

particle_skip(*args, **kwargs)#

Specify how many particle tracks should be displayed.

radius(*args, **kwargs)#

Set the radius for particle track (ribbons/cylinder only) cross-section.

report_default_variables(*args, **kwargs)#

Set the report variables to default.

report_to(*args, **kwargs)#

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

report_type(*args, **kwargs)#

Set the report type for particle tracks.

report_variables(*args, **kwargs)#

Set the report variables.

sphere_attrib(*args, **kwargs)#

Specify 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)

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

diameter(*args, **kwargs)

Diameter of the spheres when vary-diameter? is disabled.

maximum(*args, **kwargs)

Set the maximum value of the sphere to be displayed.

minimum(*args, **kwargs)

Set the minimum value of the sphere to be displayed.

scale_factor(*args, **kwargs)

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

size_variable(*args, **kwargs)

Select a particle variable to size the spheres.

smooth_parameter(*args, **kwargs)

Specify number of slices to be used in drawing spheres.

vary_diameter(*args, **kwargs)

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

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

diameter(*args, **kwargs)#

Diameter of the spheres when vary-diameter? is disabled.

maximum(*args, **kwargs)#

Set the maximum value of the sphere to be displayed.

minimum(*args, **kwargs)#

Set the minimum value of the sphere to be displayed.

scale_factor(*args, **kwargs)#

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

size_variable(*args, **kwargs)#

Select a particle variable to size the spheres.

smooth_parameter(*args, **kwargs)#

Specify number of slices to be used in drawing spheres.

vary_diameter(*args, **kwargs)#

Specify whether the spheres can vary with another variable.

style(*args, **kwargs)#

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

track_single_particle_stream(*args, **kwargs)#

Specify the stream ID to be tracked.

twist_factor(*args, **kwargs)#

Set the scale factor for twisting (ribbons only).

class vector_settings(path, service)#

Bases: TUIMenu

Set vector specific input.

Methods:

color_variable(*args, **kwargs)

Specify 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)

Specify a constant color for the vectors.

length_to_head_ratio(*args, **kwargs)

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

length_variable(*args, **kwargs)

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

scale_factor(*args, **kwargs)

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

style(*args, **kwargs)

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

vector_length(*args, **kwargs)

Specify the length of constant vectors.

vector_length_variable(*args, **kwargs)

Select a particle variable to specify the length of vectors.

vector_variable(*args, **kwargs)

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

Specify 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)#

Specify a constant color for the vectors.

length_to_head_ratio(*args, **kwargs)#

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

length_variable(*args, **kwargs)#

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

scale_factor(*args, **kwargs)#

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

style(*args, **kwargs)#

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

vector_length(*args, **kwargs)#

Specify the length of constant vectors.

vector_length_variable(*args, **kwargs)#

Select a particle variable to specify the length of vectors.

vector_variable(*args, **kwargs)#

Select a particle vector function to specify vector direction.

class path_lines(path, service)#

Bases: TUIMenu

Enter the path-lines menu to set parameters for the display of pathlines.

Methods:

arrow_scale(*args, **kwargs)

Set the scale factor for arrows drawn on pathlines.

arrow_space(*args, **kwargs)

Set the spacing factor for arrows drawn on pathlines.

display_steps(*args, **kwargs)

Set the display stepping for pathlines.

error_control(*args, **kwargs)

Set error control during pathline computation.

line_width(*args, **kwargs)

Set the width for pathlines.

marker_size(*args, **kwargs)

Set the marker size for particle drawing.

maximum_error(*args, **kwargs)

Set the maximum error allowed while computing the pathlines.

maximum_steps(*args, **kwargs)

Set the maximum number of steps to take for pathlines.

radius(*args, **kwargs)

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

relative_pathlines(*args, **kwargs)

Enable/disable the tracking of pathlines in a relative coordinate system.

reverse(*args, **kwargs)

Enable/disable the direction of path tracking.

sphere_attrib(*args, **kwargs)

Specify size and no.

step_size(*args, **kwargs)

Set the step length between particle positions for path-lines.

style(*args, **kwargs)

Set display style for pathlines (line/ribbon/cylinder).

track_in_phase(*args, **kwargs)

Assign phase to display pathlines in.

twist_factor(*args, **kwargs)

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

Set the scale factor for arrows drawn on pathlines.

arrow_space(*args, **kwargs)#

Set the spacing factor for arrows drawn on pathlines.

display_steps(*args, **kwargs)#

Set the display stepping for pathlines.

error_control(*args, **kwargs)#

Set error control during pathline computation.

line_width(*args, **kwargs)#

Set the width for pathlines.

marker_size(*args, **kwargs)#

Set the marker size for particle drawing.

maximum_error(*args, **kwargs)#

Set the maximum error allowed while computing the pathlines.

maximum_steps(*args, **kwargs)#

Set the maximum number of steps to take for pathlines.

radius(*args, **kwargs)#

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

relative_pathlines(*args, **kwargs)#

Enable/disable the tracking of pathlines in a relative coordinate system.

reverse(*args, **kwargs)#

Enable/disable the direction of path tracking.

sphere_attrib(*args, **kwargs)#

Specify size and no. of slices to be used in drawing sphere for sphere-style.

step_size(*args, **kwargs)#

Set the step length between particle positions for path-lines.

style(*args, **kwargs)#

Set display style for pathlines (line/ribbon/cylinder).

track_in_phase(*args, **kwargs)#

Assign phase to display pathlines in.

twist_factor(*args, **kwargs)#

Set the scale factor for twisting (ribbons only).

periodic_instancing(*args, **kwargs)#

Set periodic instancing.

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)#

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

render_mesh(*args, **kwargs)#

Enable/disable rendering the mesh on top of contours, vectors, etc.

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

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

Methods:

auto_scale(*args, **kwargs)

Enable/disable auto-scale of all vectors so that vector overlap is minimal.

color(*args, **kwargs)

Set the color used for all vectors.

color_levels(*args, **kwargs)

Set the number of colors used from the color map.

component_x(*args, **kwargs)

Enable/disable use of x-component of vectors.

component_y(*args, **kwargs)

Enable/disable use of y-component of vectors.

component_z(*args, **kwargs)

Enable/disable use of z-component of vectors.

constant_length(*args, **kwargs)

Enable/disable setting all vectors to have the same length.

global_range(*args, **kwargs)

Enable/disable the global range for vectors option.

in_plane(*args, **kwargs)

Toggle the display of in-plane velocity vectors.

log_scale(*args, **kwargs)

Enable/disable the use of a log scale.

node_values(*args, **kwargs)

Enable/disable plotting node values.

relative(*args, **kwargs)

Enable/disable the display of relative velocity vectors.

render_mesh(*args, **kwargs)

Enable/disable rendering the mseh on top of contours, vectors, etc.

scale(*args, **kwargs)

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

scale_head(*args, **kwargs)

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

style(*args, **kwargs)

Set the style with which the vectors will be drawn.

surfaces(*args, **kwargs)

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

Enable/disable auto-scale of all vectors so that vector overlap is minimal.

color(*args, **kwargs)#

Set the color used for all vectors. Set color to the null string to use the color map.

color_levels(*args, **kwargs)#

Set the number of colors used from the color map.

component_x(*args, **kwargs)#

Enable/disable use of x-component of vectors.

component_y(*args, **kwargs)#

Enable/disable use of y-component of vectors.

component_z(*args, **kwargs)#

Enable/disable use of z-component of vectors.

constant_length(*args, **kwargs)#

Enable/disable setting all vectors to have the same length.

global_range(*args, **kwargs)#

Enable/disable the global range for vectors option.

in_plane(*args, **kwargs)#

Toggle the display of in-plane velocity vectors.

log_scale(*args, **kwargs)#

Enable/disable the use of a log scale.

node_values(*args, **kwargs)#

Enable/disable plotting node values. Cell values will be plotted if “no”.

relative(*args, **kwargs)#

Enable/disable the display of relative velocity vectors.

render_mesh(*args, **kwargs)#

Enable/disable rendering the mseh on top of contours, vectors, etc.

scale(*args, **kwargs)#

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

scale_head(*args, **kwargs)#

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

style(*args, **kwargs)#

Set the style with which the vectors will be drawn.

surfaces(*args, **kwargs)#

Set surfaces on which vectors are drawn.

class windows(path, service)#

Bases: TUIMenu

Enter the window options menu.

Methods:

aspect_ratio(*args, **kwargs)

.

logo(*args, **kwargs)

.

logo_color(*args, **kwargs)

.

ruler(*args, **kwargs)

.

Classes:

axes(path, service)

.

main(path, service)

.

scale(path, service)

.

text(path, service)

.

video(path, service)

.

xy(path, service)

.
aspect_ratio(*args, **kwargs)#

.

class axes(path, service)#

Bases: TUIMenu

.

Methods:

border(*args, **kwargs)

.

bottom(*args, **kwargs)

.

clear(*args, **kwargs)

.

right(*args, **kwargs)

.

visible(*args, **kwargs)

.
border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

clear(*args, **kwargs)#

.

right(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

.

logo_color(*args, **kwargs)#

.

class main(path, service)#

Bases: TUIMenu

.

Methods:

border(*args, **kwargs)

.

bottom(*args, **kwargs)

.

left(*args, **kwargs)

.

right(*args, **kwargs)

.

top(*args, **kwargs)

.

visible(*args, **kwargs)

.
border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

left(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

ruler(*args, **kwargs)#

.

class scale(path, service)#

Bases: TUIMenu

.

Methods:

border(*args, **kwargs)

.

bottom(*args, **kwargs)

.

clear(*args, **kwargs)

.

font_size(*args, **kwargs)

.

format(*args, **kwargs)

.

left(*args, **kwargs)

.

margin(*args, **kwargs)

.

right(*args, **kwargs)

.

top(*args, **kwargs)

.

visible(*args, **kwargs)

.
border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

clear(*args, **kwargs)#

.

font_size(*args, **kwargs)#

.

format(*args, **kwargs)#

.

left(*args, **kwargs)#

.

margin(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

class text(path, service)#

Bases: TUIMenu

.

Methods:

alignment(*args, **kwargs)

.

application(*args, **kwargs)

.

border(*args, **kwargs)

.

bottom(*args, **kwargs)

.

clear(*args, **kwargs)

.

company(*args, **kwargs)

.

date(*args, **kwargs)

.

left(*args, **kwargs)

.

right(*args, **kwargs)

.

top(*args, **kwargs)

.

visible(*args, **kwargs)

.
alignment(*args, **kwargs)#

.

application(*args, **kwargs)#

.

border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

clear(*args, **kwargs)#

.

company(*args, **kwargs)#

.

date(*args, **kwargs)#

.

left(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

class video(path, service)#

Bases: TUIMenu

.

Methods:

background(*args, **kwargs)

.

color_filter(*args, **kwargs)

.

foreground(*args, **kwargs)

.

on(*args, **kwargs)

.

pixel_size(*args, **kwargs)

.
background(*args, **kwargs)#

.

color_filter(*args, **kwargs)#

.

foreground(*args, **kwargs)#

.

on(*args, **kwargs)#

.

pixel_size(*args, **kwargs)#

.

class xy(path, service)#

Bases: TUIMenu

.

Methods:

border(*args, **kwargs)

.

bottom(*args, **kwargs)

.

left(*args, **kwargs)

.

right(*args, **kwargs)

.

top(*args, **kwargs)

.

visible(*args, **kwargs)

.
border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

left(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

zero_angle_dir(*args, **kwargs)#

Set the vector having zero angular coordinates.

set_list_tree_separator(*args, **kwargs)#

Set the separator character for list tree.

surface_cells(*args, **kwargs)#

Draw the cells on the specified surfaces.

surface_mesh(*args, **kwargs)#

Draw the mesh defined by the specified surfaces.

vector(*args, **kwargs)#

Display space vectors.

velocity_vector(*args, **kwargs)#

Display velocity vectors.

zone_mesh(*args, **kwargs)#

Draw the mesh defined by specified face zones.

hsf_file(*args, **kwargs)#

Display hoops stream file data to active graphics window.

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.

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.

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.

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.

class graphics_window(path, service)#

Bases: TUIMenu

Enter graphics window menu.

Methods:

close_window(*args, **kwargs)

Close a user graphics window.

close_window_by_name(*args, **kwargs)

Close a reserved graphics window by its name.

open_window(*args, **kwargs)

Open a user graphics window.

save_picture(*args, **kwargs)

Generate a "hardcopy" of the active window.

set_window(*args, **kwargs)

Set a user graphics window to be the active window.

set_window_by_name(*args, **kwargs)

Set a reserved graphics window to be the active window by its name.

update_layout(*args, **kwargs)

Update the fluent layout.

Classes:

display_states(path, service)

Enter the display state manipulation menu.

embedded_windows(path, service)

Enter to embed, close, move-out embedded windows.

picture(path, service)

Enter the hardcopy/save-picture options menu.

titles(path, service)

Set problem title.

view_sync(path, service)

Enter the display state manipulation menu.

views(path, service)

Enter the view manipulation menu.

windows(path, service)

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

Close a user graphics window.

close_window_by_name(*args, **kwargs)#

Close a reserved graphics window by its name.

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 to embed, close, move-out embedded windows.

Methods:

close(*args, **kwargs)

Close an embedded window.

close_all(*args, **kwargs)

Close all embedded windows for given parent window.

embed_in(*args, **kwargs)

Embed Window into another window.

move_out(*args, **kwargs)

Move out an embedded window.

move_out_all(*args, **kwargs)

Move out all embedded windows for given parent window.
close(*args, **kwargs)#

Close an embedded window.

close_all(*args, **kwargs)#

Close all embedded windows for given parent window.

embed_in(*args, **kwargs)#

Embed Window into another window.

move_out(*args, **kwargs)#

Move out an embedded window.

move_out_all(*args, **kwargs)#

Move out all embedded windows for given parent window.

open_window(*args, **kwargs)#

Open a user graphics window.

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

save_picture(*args, **kwargs)#

Generate a “hardcopy” of the active window.

set_window(*args, **kwargs)#

Set a user graphics window to be the active window.

set_window_by_name(*args, **kwargs)#

Set a reserved graphics window to be the active window by its name.

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.

update_layout(*args, **kwargs)#

Update the fluent layout.

class view_sync(path, service)#

Bases: TUIMenu

Enter the display state manipulation menu.

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)

.

default_view(*args, **kwargs)

.

delete_view(*args, **kwargs)

.

last_view(*args, **kwargs)

.

list_views(*args, **kwargs)

.

next_view(*args, **kwargs)

.

read_views(*args, **kwargs)

.

restore_view(*args, **kwargs)

.

save_view(*args, **kwargs)

.

write_views(*args, **kwargs)

.

Classes:

camera(path, service)

.

display_states(path, service)

.
auto_scale(*args, **kwargs)#

.

class camera(path, service)#

Bases: TUIMenu

.

Methods:

dolly_camera(*args, **kwargs)

.

field(*args, **kwargs)

.

orbit_camera(*args, **kwargs)

.

pan_camera(*args, **kwargs)

.

position(*args, **kwargs)

.

projection(*args, **kwargs)

.

roll_camera(*args, **kwargs)

.

target(*args, **kwargs)

.

up_vector(*args, **kwargs)

.

zoom_camera(*args, **kwargs)

.
dolly_camera(*args, **kwargs)#

.

field(*args, **kwargs)#

.

orbit_camera(*args, **kwargs)#

.

pan_camera(*args, **kwargs)#

.

position(*args, **kwargs)#

.

projection(*args, **kwargs)#

.

roll_camera(*args, **kwargs)#

.

target(*args, **kwargs)#

.

up_vector(*args, **kwargs)#

.

zoom_camera(*args, **kwargs)#

.

default_view(*args, **kwargs)#

.

delete_view(*args, **kwargs)#

.

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)#

.

list_views(*args, **kwargs)#

.

next_view(*args, **kwargs)#

.

read_views(*args, **kwargs)#

.

restore_view(*args, **kwargs)#

.

save_view(*args, **kwargs)#

.

write_views(*args, **kwargs)#

.

class windows(path, service)#

Bases: TUIMenu

Enter the window options menu.

Methods:

aspect_ratio(*args, **kwargs)

.

logo(*args, **kwargs)

.

logo_color(*args, **kwargs)

.

ruler(*args, **kwargs)

.

Classes:

axes(path, service)

.

main(path, service)

.

scale(path, service)

.

text(path, service)

.

video(path, service)

.

xy(path, service)

.
aspect_ratio(*args, **kwargs)#

.

class axes(path, service)#

Bases: TUIMenu

.

Methods:

border(*args, **kwargs)

.

bottom(*args, **kwargs)

.

clear(*args, **kwargs)

.

right(*args, **kwargs)

.

visible(*args, **kwargs)

.
border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

clear(*args, **kwargs)#

.

right(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

.

logo_color(*args, **kwargs)#

.

class main(path, service)#

Bases: TUIMenu

.

Methods:

border(*args, **kwargs)

.

bottom(*args, **kwargs)

.

left(*args, **kwargs)

.

right(*args, **kwargs)

.

top(*args, **kwargs)

.

visible(*args, **kwargs)

.
border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

left(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

ruler(*args, **kwargs)#

.

class scale(path, service)#

Bases: TUIMenu

.

Methods:

border(*args, **kwargs)

.

bottom(*args, **kwargs)

.

clear(*args, **kwargs)

.

font_size(*args, **kwargs)

.

format(*args, **kwargs)

.

left(*args, **kwargs)

.

margin(*args, **kwargs)

.

right(*args, **kwargs)

.

top(*args, **kwargs)

.

visible(*args, **kwargs)

.
border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

clear(*args, **kwargs)#

.

font_size(*args, **kwargs)#

.

format(*args, **kwargs)#

.

left(*args, **kwargs)#

.

margin(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

class text(path, service)#

Bases: TUIMenu

.

Methods:

alignment(*args, **kwargs)

.

application(*args, **kwargs)

.

border(*args, **kwargs)

.

bottom(*args, **kwargs)

.

clear(*args, **kwargs)

.

company(*args, **kwargs)

.

date(*args, **kwargs)

.

left(*args, **kwargs)

.

right(*args, **kwargs)

.

top(*args, **kwargs)

.

visible(*args, **kwargs)

.
alignment(*args, **kwargs)#

.

application(*args, **kwargs)#

.

border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

clear(*args, **kwargs)#

.

company(*args, **kwargs)#

.

date(*args, **kwargs)#

.

left(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

class video(path, service)#

Bases: TUIMenu

.

Methods:

background(*args, **kwargs)

.

color_filter(*args, **kwargs)

.

foreground(*args, **kwargs)

.

on(*args, **kwargs)

.

pixel_size(*args, **kwargs)

.
background(*args, **kwargs)#

.

color_filter(*args, **kwargs)#

.

foreground(*args, **kwargs)#

.

on(*args, **kwargs)#

.

pixel_size(*args, **kwargs)#

.

class xy(path, service)#

Bases: TUIMenu

.

Methods:

border(*args, **kwargs)

.

bottom(*args, **kwargs)

.

left(*args, **kwargs)

.

right(*args, **kwargs)

.

top(*args, **kwargs)

.

visible(*args, **kwargs)

.
border(*args, **kwargs)#

.

bottom(*args, **kwargs)#

.

left(*args, **kwargs)#

.

right(*args, **kwargs)#

.

top(*args, **kwargs)#

.

visible(*args, **kwargs)#

.

class plot(path, service)#

Bases: TUIMenu

Enter the XY plot menu.

Classes:

ansys_sound_analysis(path, service)

Ansys Sound analysis and specification.

cumulative_plot(path, service)

Plot Cumulative Force and Moments.

flamelet_curves(path, service)

Plot flamelet curves.

Methods:

change_fft_ref_pressure(*args, **kwargs)

Change acoustic reference pressure.

circum_avg_axial(*args, **kwargs)

Compute iso-axial band surfaces and plot data vs axial coordinate on them.

circum_avg_radial(*args, **kwargs)

Compute iso-radial band surfaces and plot data vs radius on them.

datasources(*args, **kwargs)

Enter the menu to set data sources.

display_profile_data(*args, **kwargs)

Plot profile data.

fft(*args, **kwargs)

Plot FFT of file data.

fft_set(*args, **kwargs)

Enter the menu to set histogram plot parameters.

file(*args, **kwargs)

Plot data from file.

file_list(*args, **kwargs)

Plot data from multiple files.

file_set(*args, **kwargs)

Enter the menu to set file plot parameters.

histogram(*args, **kwargs)

Plot a histogram of a specified scalar quantity.

histogram_set(*args, **kwargs)

Enter the menu to set histogram plot parameters.

label_alignment(*args, **kwargs)

Set the alignment of xy plot label to horizontal or axis aligned.

plot(*args, **kwargs)

Plot solution on surfaces.

plot_direction(*args, **kwargs)

Set plot direction for xy plot.

residuals(*args, **kwargs)

Plot equation residual history.

residuals_set(*args, **kwargs)

Enter the menu to set residual plot parameters.

set_boundary_val_off(*args, **kwargs)

Set boundary value off when node values off for XY/Solution Plot.

solution(*args, **kwargs)

Plot solution on surfaces and/or zones.

solution_set(*args, **kwargs)

Enter the menu to set solution plot parameters.
class ansys_sound_analysis(path, service)#

Bases: TUIMenu

Ansys Sound analysis and specification.

Methods:

print_indicators(*args, **kwargs)

Print Ansys Sound indicators.

write_files(*args, **kwargs)

Write Ansys Sound out files.
print_indicators(*args, **kwargs)#

Print Ansys Sound indicators.

write_files(*args, **kwargs)#

Write Ansys Sound out files.

change_fft_ref_pressure(*args, **kwargs)#

Change acoustic reference pressure.

circum_avg_axial(*args, **kwargs)#

Compute iso-axial band surfaces and plot data vs axial coordinate on them.

circum_avg_radial(*args, **kwargs)#

Compute iso-radial band surfaces and plot data vs radius on them.

class cumulative_plot(path, service)#

Bases: TUIMenu

Plot Cumulative Force and Moments.

Methods:

add(*args, **kwargs)

Add a new object.

axes(*args, **kwargs)

Set axes options of an object.

curves(*args, **kwargs)

Set curves options of an object.

delete(*args, **kwargs)

Delete an object.

edit(*args, **kwargs)

Edit an object.

list(*args, **kwargs)

List objects.

list_properties(*args, **kwargs)

List properties of an object.

plot(*args, **kwargs)

Plot the Cumulative Forces/Moments.

print(*args, **kwargs)

Print the Cumulative Forces/Moments.

write(*args, **kwargs)

Write the Cumulative Forces/Moments.
add(*args, **kwargs)#

Add a new object.

axes(*args, **kwargs)#

Set axes options of an object.

curves(*args, **kwargs)#

Set curves options of an object.

delete(*args, **kwargs)#

Delete an object.

edit(*args, **kwargs)#

Edit an object.

list(*args, **kwargs)#

List objects.

list_properties(*args, **kwargs)#

List properties of an object.

plot(*args, **kwargs)#

Plot the Cumulative Forces/Moments.

print(*args, **kwargs)#

Print the Cumulative Forces/Moments.

write(*args, **kwargs)#

Write the Cumulative Forces/Moments.

datasources(*args, **kwargs)#

Enter the menu to set data sources.

display_profile_data(*args, **kwargs)#

Plot profile data.

fft(*args, **kwargs)#

Plot FFT of file data.

fft_set(*args, **kwargs)#

Enter the menu to set histogram plot parameters.

file(*args, **kwargs)#

Plot data from file.

file_list(*args, **kwargs)#

Plot data from multiple files.

file_set(*args, **kwargs)#

Enter the menu to set file plot parameters.

class flamelet_curves(path, service)#

Bases: TUIMenu

Plot flamelet curves.

Methods:

plot_curves(*args, **kwargs)

Plot of a property.

write_to_file(*args, **kwargs)

Write curve to a file instead of plot.
plot_curves(*args, **kwargs)#

Plot of a property.

write_to_file(*args, **kwargs)#

Write curve to a file instead of plot.

histogram(*args, **kwargs)#

Plot a histogram of a specified scalar quantity.

histogram_set(*args, **kwargs)#

Enter the menu to set histogram plot parameters.

label_alignment(*args, **kwargs)#

Set the alignment of xy plot label to horizontal or axis aligned.

plot(*args, **kwargs)#

Plot solution on surfaces.

plot_direction(*args, **kwargs)#

Set plot direction for xy plot.

residuals(*args, **kwargs)#

Plot equation residual history.

residuals_set(*args, **kwargs)#

Enter the menu to set residual plot parameters.

set_boundary_val_off(*args, **kwargs)#

Set boundary value off when node values off for XY/Solution Plot. Note: This setting is valid for current Fluent session only.

solution(*args, **kwargs)#

Plot solution on surfaces and/or zones.

solution_set(*args, **kwargs)#

Enter the menu to set solution plot parameters.

class report(path, service)#

Bases: TUIMenu

Enter the report menu.

Methods:

aero_optical_distortions(*args, **kwargs)

Optics report menu.

dpm_extended_summary(*args, **kwargs)

Print extended discrete phase summary report of particle fates, with options.

dpm_sample(*args, **kwargs)

Sample trajectories at boundaries and lines/planes.

dpm_sample_output_udf(*args, **kwargs)

Set the DPM sampling output UDF.

dpm_sample_sort_file(*args, **kwargs)

Enable writing of sorted DPM sample files.

dpm_summary(*args, **kwargs)

Print discrete phase summary report of particle fates.

dpm_zone_summaries_per_injection(*args, **kwargs)

Enable per-injection zone DPM summaries.

element_mass_flow(*args, **kwargs)

Print list of element mass flow rates at boundaries.

mphase_summary(*args, **kwargs)

Multiphase Summary and Recommendations.

particle_summary(*args, **kwargs)

Print summary report for all current particles.

path_line_summary(*args, **kwargs)

Print path-line-summary report.

print_histogram(*args, **kwargs)

Print a histogram of a scalar quantity.

projected_surface_area(*args, **kwargs)

Print total area of the projection of a group of surfaces to a plane.

species_mass_flow(*args, **kwargs)

Print list of species mass flow rates at boundaries.

summary(*args, **kwargs)

Print report summary.

surface_integrals(*args, **kwargs)

Surface Integral menu.

uds_flow(*args, **kwargs)

Print list of UDS flow rate at boundaries.

volume_integrals(*args, **kwargs)

Volume Integral menu.

write_histogram(*args, **kwargs)

Write a histogram of a scalar quantity to a file.

Classes:

dpm_histogram(path, service)

Enter the DPM histogram menu.

fluxes(path, service)

Flux report menu.

forces(path, service)

Force report menu.

heat_exchanger(path, service)

Enter the heat exchanger menu.

icing(path, service)

Icing reports menu.

modified_setting(path, service)

Enter the menu for setting up the Modified Settings Summary table.

population_balance(path, service)

Population Balance menu.

reference_values(path, service)

Reference value menu.

simulation_reports(path, service)

Enter the simulation reports menu.

system(path, service)

Sytem menu.
aero_optical_distortions(*args, **kwargs)#

Optics report menu.

dpm_extended_summary(*args, **kwargs)#

Print extended discrete phase summary report of particle fates, with options.

class dpm_histogram(path, service)#

Bases: TUIMenu

Enter the DPM histogram menu.

Methods:

compute_sample(*args, **kwargs)

Compute minimum/maximum of a sample variable.

delete_sample(*args, **kwargs)

Delete a sample from loaded sample list.

list_samples(*args, **kwargs)

Show all samples in loaded sample list.

pick_sample_to_reduce(*args, **kwargs)

Pick a sample for which to first set-up and then perform the data reduction.

plot_sample(*args, **kwargs)

Plot a histogram of a loaded sample.

prep_dpm_sample_cont_plot_exprs(*args, **kwargs)

Prepare named expressions from data in a DPM sample file (collected at a cut plane surface) for contour plotting.

read_sample(*args, **kwargs)

Read a sample file and add it to the sample list.

reduce_picked_sample(*args, **kwargs)

Reduce a sample after first picking it and setting up all data-reduction options and parameters.

write_sample(*args, **kwargs)

Write a histogram of a loaded sample into a file.

Classes:

set(path, service)

Enter the settings menu for the histogram.

setup_reduction(path, service)

Set up the sample data reduction by specifying all relevant options and setting parameters as desired.
compute_sample(*args, **kwargs)#

Compute minimum/maximum of a sample variable.

delete_sample(*args, **kwargs)#

Delete a sample from loaded sample list.

list_samples(*args, **kwargs)#

Show all samples in loaded sample list.

pick_sample_to_reduce(*args, **kwargs)#

Pick a sample for which to first set-up and then perform the data reduction.

plot_sample(*args, **kwargs)#

Plot a histogram of a loaded sample.

prep_dpm_sample_cont_plot_exprs(*args, **kwargs)#

Prepare named expressions from data in a DPM sample file (collected at a cut plane surface) for contour plotting.

read_sample(*args, **kwargs)#

Read a sample file and add it to the sample list.

reduce_picked_sample(*args, **kwargs)#

Reduce a sample after first picking it and setting up all data-reduction options and parameters.

class set(path, service)#

Bases: TUIMenu

Enter the settings menu for the histogram.

Methods:

auto_range(*args, **kwargs)

Automatically compute range of sampling variable for histogram plots.

correlation(*args, **kwargs)

Compute correlation of sampling variable with other variable.

cumulation_curve(*args, **kwargs)

Compute a cumulative curve for sampling variable or correlation variable when correlation? was specified.

diameter_statistics(*args, **kwargs)

Compute Rosin Rammler parameters, Sauter and other mean diameters.

histogram_mode(*args, **kwargs)

Use bars for histogram plot or xy-style.

logarithmic(*args, **kwargs)

Use logarithmic scaling on the abscissa (variable axis)? -- Will not work unless all values are positive.

maximum(*args, **kwargs)

Specify maximum value of x-axis variable for histogram plots.

minimum(*args, **kwargs)

Specify mimimum value of x-axis variable for histogram plots.

number_of_bins(*args, **kwargs)

Specify the number of bins.

percentage(*args, **kwargs)

Use percentages of bins to be computed.

variable_power_3(*args, **kwargs)

Use the cubic of the cumulation variable during computation of the cumulative curve.

weighting(*args, **kwargs)

Use weighting with additional variable when sorting data into samples.
auto_range(*args, **kwargs)#

Automatically compute range of sampling variable for histogram plots.

correlation(*args, **kwargs)#

Compute correlation of sampling variable with other variable.

cumulation_curve(*args, **kwargs)#

Compute a cumulative curve for sampling variable or correlation variable when correlation? was specified.

diameter_statistics(*args, **kwargs)#

Compute Rosin Rammler parameters, Sauter and other mean diameters. Requires specification of diameter as sampling variable.

histogram_mode(*args, **kwargs)#

Use bars for histogram plot or xy-style.

logarithmic(*args, **kwargs)#

Use logarithmic scaling on the abscissa (variable axis)? – Will not work unless all values are positive.

maximum(*args, **kwargs)#

Specify maximum value of x-axis variable for histogram plots.

minimum(*args, **kwargs)#

Specify mimimum value of x-axis variable for histogram plots.

number_of_bins(*args, **kwargs)#

Specify the number of bins.

percentage(*args, **kwargs)#

Use percentages of bins to be computed.

variable_power_3(*args, **kwargs)#

Use the cubic of the cumulation variable during computation of the cumulative curve. When the particle mass was not sampled, the diameter can be used instead.

weighting(*args, **kwargs)#

Use weighting with additional variable when sorting data into samples.

class setup_reduction(path, service)#

Bases: TUIMenu

Set up the sample data reduction by specifying all relevant options and setting parameters as desired.

Methods:

all_variables_number_of_bins(*args, **kwargs)

Set the number of bins to be used for ALL variables in the data reduction.

list_settings(*args, **kwargs)

List all user inputs for the sample picked for data reduction.

logarithmic(*args, **kwargs)

Switch on or off logarithmic scaling to be used for a specific variable in the data reduction.

make_steady_from_unsteady_file(*args, **kwargs)

Specify whether the unsteady sample is to be reduced into a steady-state injection file.

maximum(*args, **kwargs)

Set the maximum value of the range to be considered for a specific variable in the data reduction.

minimum(*args, **kwargs)

Set the minimum value of the range to be considered for a specific variable in the data reduction.

number_of_bins(*args, **kwargs)

Set the number of bins to be used for a specific variable in the data reduction.

reset_min_and_max(*args, **kwargs)

Reset the min and max values of the range to be considered for a specific variable in the data reduction.

use_weighting(*args, **kwargs)

Specify whether to use any weighting in the averaging that is done in each bin in the data reduction.

weighting_variable(*args, **kwargs)

Choose the weighting variable for the averaging in each bin in the data reduction.
all_variables_number_of_bins(*args, **kwargs)#

Set the number of bins to be used for ALL variables in the data reduction.

list_settings(*args, **kwargs)#

List all user inputs for the sample picked for data reduction.

logarithmic(*args, **kwargs)#

Switch on or off logarithmic scaling to be used for a specific variable in the data reduction.

make_steady_from_unsteady_file(*args, **kwargs)#

Specify whether the unsteady sample is to be reduced into a steady-state injection file.

maximum(*args, **kwargs)#

Set the maximum value of the range to be considered for a specific variable in the data reduction.

minimum(*args, **kwargs)#

Set the minimum value of the range to be considered for a specific variable in the data reduction.

number_of_bins(*args, **kwargs)#

Set the number of bins to be used for a specific variable in the data reduction.

reset_min_and_max(*args, **kwargs)#

Reset the min and max values of the range to be considered for a specific variable in the data reduction.

use_weighting(*args, **kwargs)#

Specify whether to use any weighting in the averaging that is done in each bin in the data reduction.

weighting_variable(*args, **kwargs)#

Choose the weighting variable for the averaging in each bin in the data reduction.

write_sample(*args, **kwargs)#

Write a histogram of a loaded sample into a file.

dpm_sample(*args, **kwargs)#

Sample trajectories at boundaries and lines/planes.

dpm_sample_output_udf(*args, **kwargs)#

Set the DPM sampling output UDF.

dpm_sample_sort_file(*args, **kwargs)#

Enable writing of sorted DPM sample files.

dpm_summary(*args, **kwargs)#

Print discrete phase summary report of particle fates.

dpm_zone_summaries_per_injection(*args, **kwargs)#

Enable per-injection zone DPM summaries.

element_mass_flow(*args, **kwargs)#

Print list of element mass flow rates at boundaries.

class fluxes(path, service)#

Bases: TUIMenu

Flux report menu.

Methods:

film_heat_transfer(*args, **kwargs)

Print film heat transfer rate at boundaries.

film_mass_flow(*args, **kwargs)

Print film mass flow rate at boundaries.

heat_transfer(*args, **kwargs)

Print heat transfer rate at boundaries.

heat_transfer_sensible(*args, **kwargs)

Print sensible heat transfer rate at boundaries.

mass_flow(*args, **kwargs)

Print mass flow rate at inlets and outlets.

pressure_work(*args, **kwargs)

Print pressure work rate at moving boundaries.

rad_heat_trans(*args, **kwargs)

Print radiation heat transfer rate at boundaries.

viscous_work(*args, **kwargs)

Print viscous work rate at boundaries.
film_heat_transfer(*args, **kwargs)#

Print film heat transfer rate at boundaries.

film_mass_flow(*args, **kwargs)#

Print film mass flow rate at boundaries.

heat_transfer(*args, **kwargs)#

Print heat transfer rate at boundaries.

heat_transfer_sensible(*args, **kwargs)#

Print sensible heat transfer rate at boundaries.

mass_flow(*args, **kwargs)#

Print mass flow rate at inlets and outlets.

pressure_work(*args, **kwargs)#

Print pressure work rate at moving boundaries.

rad_heat_trans(*args, **kwargs)#

Print radiation heat transfer rate at boundaries.

viscous_work(*args, **kwargs)#

Print viscous work rate at boundaries.

class forces(path, service)#

Bases: TUIMenu

Force report menu.

Methods:

pressure_center(*args, **kwargs)

Print center of pressure on wall zones.

wall_forces(*args, **kwargs)

Print integrated pressure and viscous forces on wall zones.

wall_moments(*args, **kwargs)

Print integrated pressure and viscous moments on wall zones.
pressure_center(*args, **kwargs)#

Print center of pressure on wall zones.

wall_forces(*args, **kwargs)#

Print integrated pressure and viscous forces on wall zones.

wall_moments(*args, **kwargs)#

Print integrated pressure and viscous moments on wall zones.

class heat_exchanger(path, service)#

Bases: TUIMenu

Enter the heat exchanger menu.

Methods:

computed_heat_rejection(*args, **kwargs)

Print total heat rejection.

inlet_temperature(*args, **kwargs)

Print inlet temperature.

mass_flow_rate(*args, **kwargs)

Print mass flow rate.

outlet_temperature(*args, **kwargs)

Print outlet temperature.

specific_heat(*args, **kwargs)

Print fluid's specific heat.
computed_heat_rejection(*args, **kwargs)#

Print total heat rejection.

inlet_temperature(*args, **kwargs)#

Print inlet temperature.

mass_flow_rate(*args, **kwargs)#

Print mass flow rate.

outlet_temperature(*args, **kwargs)#

Print outlet temperature.

specific_heat(*args, **kwargs)#

Print fluid’s specific heat.

class icing(path, service)#

Bases: TUIMenu

Icing reports menu.

Methods:

energy_of_ice_formation(*args, **kwargs)

Print Energy of Ice Formation.

energy_of_water_impinged(*args, **kwargs)

Print Energy of Water Impingement.

icing_energy_of_conduction(*args, **kwargs)

Print Energy of Conduction.

mass_of_ice(*args, **kwargs)

Print Mass of Ice Accretion.

mass_of_water_impinged(*args, **kwargs)

Print Mass of Water Impingement.

particles_crystals_collection_eff(*args, ...)

Print Crystals Collection Efficiency.

particles_droplets_collection_eff(*args, ...)

Print Droplets Collection Efficiency.
energy_of_ice_formation(*args, **kwargs)#

Print Energy of Ice Formation.

energy_of_water_impinged(*args, **kwargs)#

Print Energy of Water Impingement.

icing_energy_of_conduction(*args, **kwargs)#

Print Energy of Conduction.

mass_of_ice(*args, **kwargs)#

Print Mass of Ice Accretion.

mass_of_water_impinged(*args, **kwargs)#

Print Mass of Water Impingement.

particles_crystals_collection_eff(*args, **kwargs)#

Print Crystals Collection Efficiency.

particles_droplets_collection_eff(*args, **kwargs)#

Print Droplets Collection Efficiency.

class modified_setting(path, service)#

Bases: TUIMenu

Enter the menu for setting up the Modified Settings Summary table.

Methods:

modified_setting(*args, **kwargs)

.

write_user_setting(*args, **kwargs)

.
modified_setting(*args, **kwargs)#

.

write_user_setting(*args, **kwargs)#

.

mphase_summary(*args, **kwargs)#

Multiphase Summary and Recommendations.

particle_summary(*args, **kwargs)#

Print summary report for all current particles.

path_line_summary(*args, **kwargs)#

Print path-line-summary report.

class population_balance(path, service)#

Bases: TUIMenu

Population Balance menu.

Methods:

moments(*args, **kwargs)

Set moments for population balance.

number_density(*args, **kwargs)

Set number density functions.
moments(*args, **kwargs)#

Set moments for population balance.

number_density(*args, **kwargs)#

Set number density functions.

print_histogram(*args, **kwargs)#

Print a histogram of a scalar quantity.

projected_surface_area(*args, **kwargs)#

Print total area of the projection of a group of surfaces to a plane.

class reference_values(path, service)#

Bases: TUIMenu

Reference value menu.

Methods:

area(*args, **kwargs)

Set reference area for normalization.

density(*args, **kwargs)

Set reference density for normalization.

depth(*args, **kwargs)

Set reference depth for volume calculation.

enthalpy(*args, **kwargs)

Set reference enthalpy for enthalpy damping and normalization.

length(*args, **kwargs)

Set reference length for normalization.

list(*args, **kwargs)

List current reference values.

pressure(*args, **kwargs)

Set reference pressure for normalization.

temperature(*args, **kwargs)

Set reference temperature for normalization.

velocity(*args, **kwargs)

Set reference velocity for normalization.

viscosity(*args, **kwargs)

Set reference viscosity for normalization.

yplus(*args, **kwargs)

Set reference yplus for normalization.

zone(*args, **kwargs)

Set reference zone.

Classes:

compute(path, service)

Enter the compute menu.
area(*args, **kwargs)#

Set reference area for normalization.

class compute(path, service)#

Bases: TUIMenu

Enter the compute menu.

Methods:

axis(*args, **kwargs)

Compute reference values from a zone of this type.

degassing(*args, **kwargs)

Compute reference values from a zone of this type.

dummy_entry(*args, **kwargs)

.

exhaust_fan(*args, **kwargs)

Compute reference values from a zone of this type.

fan(*args, **kwargs)

Compute reference values from a zone of this type.

fluid(*args, **kwargs)

Compute reference values from a zone of this type.

geometry(*args, **kwargs)

Compute reference values from a zone of this type.

inlet_vent(*args, **kwargs)

Compute reference values from a zone of this type.

intake_fan(*args, **kwargs)

Compute reference values from a zone of this type.

interface(*args, **kwargs)

Compute reference values from a zone of this type.

interior(*args, **kwargs)

Compute reference values from a zone of this type.

mass_flow_inlet(*args, **kwargs)

Compute reference values from a zone of this type.

mass_flow_outlet(*args, **kwargs)

Compute reference values from a zone of this type.

network(*args, **kwargs)

Compute reference values from a zone of this type.

network_end(*args, **kwargs)

Compute reference values from a zone of this type.

outflow(*args, **kwargs)

Compute reference values from a zone of this type.

outlet_vent(*args, **kwargs)

Compute reference values from a zone of this type.

overset(*args, **kwargs)

Compute reference values from a zone of this type.

periodic(*args, **kwargs)

Compute reference values from a zone of this type.

porous_jump(*args, **kwargs)

Compute reference values from a zone of this type.

pressure_far_field(*args, **kwargs)

Compute reference values from a zone of this type.

pressure_inlet(*args, **kwargs)

Compute reference values from a zone of this type.

pressure_outlet(*args, **kwargs)

Compute reference values from a zone of this type.

radiator(*args, **kwargs)

Compute reference values from a zone of this type.

rans_les_interface(*args, **kwargs)

Compute reference values from a zone of this type.

recirculation_inlet(*args, **kwargs)

Compute reference values from a zone of this type.

recirculation_outlet(*args, **kwargs)

Compute reference values from a zone of this type.

shadow(*args, **kwargs)

Compute reference values from a zone of this type.

solid(*args, **kwargs)

Compute reference values from a zone of this type.

symmetry(*args, **kwargs)

Compute reference values from a zone of this type.

velocity_inlet(*args, **kwargs)

Compute reference values from a zone of this type.

wall(*args, **kwargs)

Compute reference values from a zone of this type.
axis(*args, **kwargs)#

Compute reference values from a zone of this type.

degassing(*args, **kwargs)#

Compute reference values from a zone of this type.

dummy_entry(*args, **kwargs)#

.

exhaust_fan(*args, **kwargs)#

Compute reference values from a zone of this type.

fan(*args, **kwargs)#

Compute reference values from a zone of this type.

fluid(*args, **kwargs)#

Compute reference values from a zone of this type.

geometry(*args, **kwargs)#

Compute reference values from a zone of this type.

inlet_vent(*args, **kwargs)#

Compute reference values from a zone of this type.

intake_fan(*args, **kwargs)#

Compute reference values from a zone of this type.

interface(*args, **kwargs)#

Compute reference values from a zone of this type.

interior(*args, **kwargs)#

Compute reference values from a zone of this type.

mass_flow_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

mass_flow_outlet(*args, **kwargs)#

Compute reference values from a zone of this type.

network(*args, **kwargs)#

Compute reference values from a zone of this type.

network_end(*args, **kwargs)#

Compute reference values from a zone of this type.

outflow(*args, **kwargs)#

Compute reference values from a zone of this type.

outlet_vent(*args, **kwargs)#

Compute reference values from a zone of this type.

overset(*args, **kwargs)#

Compute reference values from a zone of this type.

periodic(*args, **kwargs)#

Compute reference values from a zone of this type.

porous_jump(*args, **kwargs)#

Compute reference values from a zone of this type.

pressure_far_field(*args, **kwargs)#

Compute reference values from a zone of this type.

pressure_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

pressure_outlet(*args, **kwargs)#

Compute reference values from a zone of this type.

radiator(*args, **kwargs)#

Compute reference values from a zone of this type.

rans_les_interface(*args, **kwargs)#

Compute reference values from a zone of this type.

recirculation_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

recirculation_outlet(*args, **kwargs)#

Compute reference values from a zone of this type.

shadow(*args, **kwargs)#

Compute reference values from a zone of this type.

solid(*args, **kwargs)#

Compute reference values from a zone of this type.

symmetry(*args, **kwargs)#

Compute reference values from a zone of this type.

velocity_inlet(*args, **kwargs)#

Compute reference values from a zone of this type.

wall(*args, **kwargs)#

Compute reference values from a zone of this type.

density(*args, **kwargs)#

Set reference density for normalization.

depth(*args, **kwargs)#

Set reference depth for volume calculation.

enthalpy(*args, **kwargs)#

Set reference enthalpy for enthalpy damping and normalization.

length(*args, **kwargs)#

Set reference length for normalization.

list(*args, **kwargs)#

List current reference values.

pressure(*args, **kwargs)#

Set reference pressure for normalization.

temperature(*args, **kwargs)#

Set reference temperature for normalization.

velocity(*args, **kwargs)#

Set reference velocity for normalization.

viscosity(*args, **kwargs)#

Set reference viscosity for normalization.

yplus(*args, **kwargs)#

Set reference yplus for normalization.

zone(*args, **kwargs)#

Set reference zone.

class simulation_reports(path, service)#

Bases: TUIMenu

Enter the simulation reports menu.

Methods:

delete_simulation_report(*args, **kwargs)

Delete the provided simulation report.

duplicate_simulation_report(*args, **kwargs)

Duplicate a report and all of its settings to a new report.

export_simulation_report_as_html(*args, **kwargs)

Export the provided simulation report as HTML.

export_simulation_report_as_pdf(*args, **kwargs)

Export the provided simulation report as a PDF file.

export_simulation_report_as_pptx(*args, **kwargs)

Export the provided simulation report as a PPT file.

generate_simulation_report(*args, **kwargs)

Generate a new simulation report or regenerate an existing simulation report with the provided name.

list_simulation_reports(*args, **kwargs)

List all report names.

read_simulation_report_template_file(*args, ...)

Read a JSON template file with existing Simulation Report settings.

rename_simulation_report(*args, **kwargs)

Rename a report which has already been generated.

reset_report_to_defaults(*args, **kwargs)

Reset all report settings to default for the provided simulation report.

view_simulation_report(*args, **kwargs)

View a simulation report that has already been generated.

write_report_names_to_file(*args, **kwargs)

Write the list of currently generated report names to a txt file.

write_simulation_report_template_file(*args, ...)

Write a JSON template file with this case's Simulation Report settings.

Classes:

parametric_study(path, service)

Enter the parametric study menu.
delete_simulation_report(*args, **kwargs)#

Delete the provided simulation report.

duplicate_simulation_report(*args, **kwargs)#

Duplicate a report and all of its settings to a new report.

export_simulation_report_as_html(*args, **kwargs)#

Export the provided simulation report as HTML.

export_simulation_report_as_pdf(*args, **kwargs)#

Export the provided simulation report as a PDF file.

export_simulation_report_as_pptx(*args, **kwargs)#

Export the provided simulation report as a PPT file.

generate_simulation_report(*args, **kwargs)#

Generate a new simulation report or regenerate an existing simulation report with the provided name.

list_simulation_reports(*args, **kwargs)#

List all report names.

class parametric_study(path, service)#

Bases: TUIMenu

Enter the parametric study menu.

Methods:

generate_design_point_report(*args, **kwargs)

Generate a simulation report for an updated design point.

generate_parametric_report(*args, **kwargs)

Generate a parametric report for your study.
generate_design_point_report(*args, **kwargs)#

Generate a simulation report for an updated design point.

generate_parametric_report(*args, **kwargs)#

Generate a parametric report for your study.

read_simulation_report_template_file(*args, **kwargs)#

Read a JSON template file with existing Simulation Report settings.

rename_simulation_report(*args, **kwargs)#

Rename a report which has already been generated.

reset_report_to_defaults(*args, **kwargs)#

Reset all report settings to default for the provided simulation report.

view_simulation_report(*args, **kwargs)#

View a simulation report that has already been generated. In batch mode this will print the report’s URL.

write_report_names_to_file(*args, **kwargs)#

Write the list of currently generated report names to a txt file.

write_simulation_report_template_file(*args, **kwargs)#

Write a JSON template file with this case’s Simulation Report settings.

species_mass_flow(*args, **kwargs)#

Print list of species mass flow rates at boundaries.

summary(*args, **kwargs)#

Print report summary.

surface_integrals(*args, **kwargs)#

Surface Integral menu.

class system(path, service)#

Bases: TUIMenu

Sytem menu.

Methods:

gpgpu_stats(*args, **kwargs)

GPGPU information.

proc_stats(*args, **kwargs)

Fluent process information.

sys_stats(*args, **kwargs)

System information.

time_stats(*args, **kwargs)

Time usage information.
gpgpu_stats(*args, **kwargs)#

GPGPU information.

proc_stats(*args, **kwargs)#

Fluent process information.

sys_stats(*args, **kwargs)#

System information.

time_stats(*args, **kwargs)#

Time usage information.

uds_flow(*args, **kwargs)#

Print list of UDS flow rate at boundaries.

volume_integrals(*args, **kwargs)#

Volume Integral menu.

write_histogram(*args, **kwargs)#

Write a histogram of a scalar quantity to a file.

class surface(path, service)#

Bases: TUIMenu

Enter the data surface manipulation menu.

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.