file#

class ansys.api.pyensight.ensight_api.file(session: Session)#

Class wrapper for EnSight file module

This class acts as a proxy for the EnSight Python module ensight.file

Methods

file.animation_color_type(p0)

File: animation_color_type

file.animation_file(p0)

Specify the name of the animation file when recording.

file.animation_format(p0)

File: animation_format

file.animation_format_options(p0)

File: animation_format_options

file.animation_frame_rate(p0)

File: animation_frame_rate

file.animation_frames(p0)

Specify the number of frames to save when recording an animation.

file.animation_gamma(p0)

File: animation_gamma

file.animation_multiple_images(p0)

Specify whether to save multiple images when recording an animation (if you are displaying on multiple detached displays).

file.animation_numpasses(p0)

File: animation_numpasses

file.animation_play_flipbook(p0)

This command has not yet been documented.

file.animation_play_keyframe(p0)

File: animation_play_keyframe

file.animation_play_time(p0)

This command has not yet been documented.

file.animation_raytrace_ext(p0)

File: animation_raytrace_ext

file.animation_raytrace_it(p0)

File: animation_raytrace_it

file.animation_rend_offscreen(p0)

File: animation_rend_offscreen

file.animation_reset_flipbook(p0)

Specify whether to reset the flipbook as the animation is saved.

file.animation_reset_keyframe(p0)

File: animation_reset_keyframe

file.animation_reset_time(p0)

Specify whether to reset the solution time as the animation is saved.

file.animation_reset_traces(p0)

Specify whether to reset the animated particle traces as the animation is saved.

file.animation_saturation(p0)

File: animation_saturation

file.animation_screen_tiling(p0, p1)

File: animation_screen_tiling

file.animation_start_number(p0)

File: animation_start_number

file.animation_stereo(p0)

File: animation_stereo

file.animation_window_size(p0)

Specify type (and thus in most cases the size) of the animation window to save when recording.

file.animation_window_xy(p0, p1)

Specify resolution of the animation window to save - when using user_defined type.

file.context_restore_rescale(p0)

File: context_restore_rescale

file.image_avi_type(p0)

File: image_avi_type

file.image_bit_rate(p0)

File: image_bit_rate

file.image_color_type(p0)

Specify that the image will be printed in color or black and white

file.image_convert(p0)

Change black backgrounds to white and change any white objects (geometry, plotters, annotations, etc.) to black.

file.image_encapsulated(p0)

Turn on/off encapsulation for postscript output

file.image_envideo_type(p0)

Set the envideo format compression scheme.

file.image_file(p0)

Specify the filename to be used for image printing.

file.image_format(p0)

Specifies the file format to be used when an image is created.

file.image_format_options(p0)

This command has not yet been documented.

file.image_frame_rate(p0)

This command has not yet been documented.

file.image_gamma(p0)

Set gamma correction value for PCL image files.

file.image_mpeg_type(p0)

File: image_mpeg_type

file.image_numpasses(p0)

Specify the number of rendering passes for anti-aliasing.

file.image_orientation(p0)

Sets the image orientation for PCL and Postscript image formats

file.image_plot_only(p0)

When printing an image will turn invisible everything except for plotters.

file.image_postscript_cull(p0)

For postscript format move-draw images turns on/off the removal of hidden geometry.

file.image_postscript_prev(p0)

Include a windows preview image in an encapsulated postscript (eps) file.

file.image_postscript_subd(p0)

For postscript format move-draw images turns on/off the subdivision of polygons for better shading.

file.image_postscript_type(p0)

Set the postscript output to move-draw or bitmap.

file.image_printer_command(p0)

Specify the printer command to use when printing an image to a printer

file.image_printer_model(p0)

Set the target printer for a PCL image file.

file.image_quality(p0)

Sets the quality for JPEG images.

file.image_raytrace_external(p0)

File: image_raytrace_external

file.image_raytrace_it(p0)

File: image_raytrace_it

file.image_rend_offscreen(p0)

File: image_rend_offscreen

file.image_saturation(p0)

Desaturate color when saving an image to disk or printer.

file.image_scale_factor(p0)

To scale a postscript image for the page size.

file.image_screen_tiling(p0, p1)

Create a multi-tile image suitable for display via EnVideo to a multi-tile (i.e., powerwall) display device.

file.image_stereo(p0)

Set stereo/mono output for the image file.

file.image_to_file(p0)

Specifies if the image should be saved to a disk file.

file.image_to_printer(p0)

Specifies if the image should be printed directly to a printer.

file.image_transparent_back(p0)

File: image_transparent_back

file.image_window_size(p0)

When printing image based images sets the window (and thus image) size.

file.image_window_xy(p0, p1)

Sets the image width and height if the user has specified a user_defined image size.

file.raytracer(p0)

File: raytracer

file.raytracer_options(p0)

File: raytracer_options

file.restore_context(p0)

Restore a context file.

file.restore_full_backup(p0)

Restore an EnSight archive (restart) file.

file.save_animation()

This command has not yet been documented.

file.save_cmd_file(p0)

File: save_cmd_file

file.save_context(p0)

Save a context file.

file.save_context_type(p0)

Can specify the desired case to use, or all cases, when saving a context file.

file.save_full_backup(p0)

Create an EnSight archive (restart) file.

file.save_geometric_entities(p0)

File: save_geometric_entities

file.save_image()

Save an image to a disk file.

file.save_multiple_images(p0)

Option to save a single image or multiple images for a flat-wall detached display.

file.save_scenario(p0)

File: save_scenario

file.save_scenario_file(p0)

Save a scenario file using all parts.

file.save_scenario_fileslct(p0)

Save a scenario file using selected parts only.

file.save_scenario_png_file(p0)

Creates an executable by name of <pathname> containing the CEI application Reveal along with the currently specified scenario file.

file.save_scenario_png_format(p0)

Specifies the architecture for the 'file: save_scenario_png_format' command.

file.save_scenario_project(p0)

Save a scenario project using all parts.

file.save_scenario_projslct(p0)

Save a scenario project using selected parts only.

file.save_scenario_view(p0, p1)

Save a view as part of an existing scenario file.

file.save_scenario_which_parts(p0)

Save a view as part of an existing scenario file.

file.save_screen_to_clipboard(p0)

File: save_screen_to_clipboard

file.save_screen_to_file(p0)

File: save_screen_to_file

file.scenario_desc_begin(args)

Delimit the description for a scenario project.

file.scenario_desc_end(p0)

Delimit the description for a scenario project.

file.scenario_flipbook_anim(p0)

When a scenario file/project is saved will determine if flipbook animation (if defined) will be included.

file.scenario_format(p0)

Sets the type of scenario format to use.

file.scenario_keyframe_anim(p0)

When a scenario file/project is saved will determine if keyframe animation (if defined) will be included.

file.scenario_simtime_anim(p0, p1, p2, p3)

File: scenario_simtime_anim

file.scenario_steptime_anim(p0, p1, p2, p3)

File: scenario_steptime_anim

file.scenario_trace_anim(p0)

When a scenario file/project is saved will determine if particle trace animation (if defined) will be included.

file.scenario_transient_anim(p0, p1, p2, p3)

When a scenario csf file is saved, will determine if transient data (if available) will be included.

file.select_begin(*args, **kwargs)

File: select_begin