animate#

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

Bases: TUIMenu

Enters the animation menu.

Classes:

define(path, service)

Enters the animation definition menu.

objects(path, service)

Enters the object manipulation menu.

playback(path, service)

Enters the animation playback menu.

pulse(path, service)

Enter the pulse animation menu (only available when one or more particle track or pathline graphics objects are defined).
class define(path, service)#

Bases: TUIMenu

Enters the animation definition menu.

Methods:

define_monitor(*args, **kwargs)

Defines new animation.

edit_monitor(*args, **kwargs)

Changes animation monitor attributes.
define_monitor(*args, **kwargs)#

Defines new animation.

edit_monitor(*args, **kwargs)#

Changes animation monitor attributes.

class objects(path, service)#

Bases: TUIMenu

Enters the object manipulation menu.

Methods:

clear_history(*args, **kwargs)

Clears solution animation object history.

copy(*args, **kwargs)

Copies solution animation object.

create(*args, **kwargs)

Creates new solution animation object.

delete(*args, **kwargs)

Deletes solution animation object.

edit(*args, **kwargs)

Edits solution animation object.
clear_history(*args, **kwargs)#

Clears solution animation object history.

copy(*args, **kwargs)#

Copies solution animation object.

create(*args, **kwargs)#

Creates new solution animation object.

delete(*args, **kwargs)#

Deletes solution animation object.

edit(*args, **kwargs)#

Edits solution animation object.

class playback(path, service)#

Bases: TUIMenu

Enters the animation playback menu.

Methods:

delete(*args, **kwargs)

Deletes animation sequence.

play(*args, **kwargs)

Plays the selected animation.

read(*args, **kwargs)

Reads new animation from file or already defined animations.

set_custom_frames(*args, **kwargs)

Specify a custom start frame, increment, and end frame for video export.

stored_view(*args, **kwargs)

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

write(*args, **kwargs)

Writes animation sequence to the file.

Classes:

video(path, service)

Enters the video menu.
delete(*args, **kwargs)#

Deletes animation sequence.

play(*args, **kwargs)#

Plays the selected animation.

read(*args, **kwargs)#

Reads new animation from file or already defined animations.

set_custom_frames(*args, **kwargs)#

Specify a custom start frame, increment, and end frame for video export.

stored_view(*args, **kwargs)#

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

class video(path, service)#

Bases: TUIMenu

Enters the video menu.

Classes:

advance_quality(path, service)

Advance Quality setting.

Methods:

format(*args, **kwargs)

Specifies what format the video file will be written in (MP4 | AVI | FLV | MOV | MPEG).

fps(*args, **kwargs)

Sets the target frames per second (FPS) for the saved video file.

height(*args, **kwargs)

Set the height for exporting video file.

name(*args, **kwargs)

Sets the name of the saved video file.

quality(*args, **kwargs)

Set quality for exporting video file.

scale(*args, **kwargs)

Expands or collapses the resolution based on this scaling factor.

set_standard_resolution(*args, **kwargs)

Select from pre-defined resolution list.

use_original_resolution(*args, **kwargs)

Controls whether the resolution of the saved video file matches that of the images used to create it.

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

Specifies what format the video file will be written in (MP4 | AVI | FLV | MOV | MPEG).

fps(*args, **kwargs)#

Sets the target frames per second (FPS) for the saved video file.

height(*args, **kwargs)#

Set the height for exporting video file.

name(*args, **kwargs)#

Sets the name of the saved video file.

quality(*args, **kwargs)#

Set quality for exporting video file.

scale(*args, **kwargs)#

Expands or collapses the resolution based on this scaling factor.

set_standard_resolution(*args, **kwargs)#

Select from pre-defined resolution list.

use_original_resolution(*args, **kwargs)#

Controls whether the resolution of the saved video file matches that of the images used to create it.

width(*args, **kwargs)#

Set the width for exporting video file.

write(*args, **kwargs)#

Writes animation sequence to the file.

class pulse(path, service)#

Bases: TUIMenu

Enter the pulse animation menu (only available when one or more particle track or pathline graphics objects are defined).

Classes:

hardcopy(path, service)

Hardcopy options menu.

video(path, service)

Enter the video window options menu.

Methods:

pulse_mode(*args, **kwargs)

Set whether the pulse is a single pulse or continuous.

write(*args, **kwargs)

Select a pathline or particle track graphics object, specify whether you want to write a video file or picture files, and enter the destination directory for the files.
class hardcopy(path, service)#

Bases: TUIMenu

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

pulse_mode(*args, **kwargs)#

Set whether the pulse is a single pulse or continuous.

class video(path, service)#

Bases: TUIMenu

Enter the video window options 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)#

Select a pathline or particle track graphics object, specify whether you want to write a video file or picture files, and enter the destination directory for the files. Continuous pulse animations result in a 5 second video. Single pulse animations run for a full cycle.