file

class ansys.fluent.core.solver.tui_241.main_menu.file(service, version, mode, path)

Bases: TUIMenu

Enter the file menu.

Classes:

async_optimize(service, version, mode, path)	Chooses whether to optimize file I/O using scratch disks and asynchronous operations.
auto_save(service, version, mode, path)	Enters the auto save menu.
binary_legacy_files(service, version, mode, path)	.
cff_files(service, version, mode, path)	.
cffio_options(service, version, mode, path)	Enters the cffio options menu, which provides options for the I/O of case and data files in the Common Fluids Format (CFF).
close_without_save(service, version, mode, path)	Exits ANSYS Fluent without saving data in Workbench.
confirm_overwrite(service, version, mode, path)	.
convert_hanging_nodes_during_read(service, ...)	.
data_file_options(service, version, mode, path)	Sets derived quantities to be written in data file.
define_macro(service, version, mode, path)	Saves input to a named macro.
em_mapping(service, version, mode, path)	Enters the electromagnetic loss mapping menu.
execute_macro(service, version, mode, path)	Runs a previously defined macro.
export(service, version, mode, path)	Enter the export menu.
export_to_cfd_post(service, version, mode, path)	Exports data files that are compatible with CFD-Post and EnSight (that is, .cdat and .cst files) and opens CFD-Post, if desired.
fsi(service, version, mode, path)	Enters the fluid-structure interaction menu.
import_(service, version, mode, path)	Enter the import menu.
interpolate(service, version, mode, path)	Interpolates data to/from another grid.
load_act_tool(service, version, mode, path)	Load ACT Start Page.
parametric_project(service, version, mode, path)	Enter to open, save, archive parametric project.
project_beta(service, version, mode, path)	Enter to create new project, open project, save and archive project.
read_case(service, version, mode, path)	Read a case file.
read_case_data(service, version, mode, path)	Reads a case and a data file.
read_case_info(service, version, mode, path)	Read basic case info.
read_case_settings(service, version, mode, path)	Read a case file while skipping mesh elements.
read_data(service, version, mode, path)	Reads a data file.
read_field_functions(service, version, mode, ...)	Reads custom field function definitions from a file.
read_gpu_restart(service, version, mode, path)	Read gpuapp restart case and data files.
read_injections(service, version, mode, path)	Reads all DPM injections from a file.
read_isat_table(service, version, mode, path)	Reads ISAT Table.
read_journal(service, version, mode, path)	Read a journal file.
read_macros(service, version, mode, path)	Reads macro definitions from a file.
read_pdf(service, version, mode, path)	Reads a PDF file.
read_profile(service, version, mode, path)	Reads boundary profile data.
read_rays(service, version, mode, path)	Reads a ray file.
read_settings(service, version, mode, path)	Reads and sets boundary conditions from a specified file.
read_surface_clusters(service, version, ...)	Reads surface clusters from a file.
read_transient_table(service, version, mode, ...)	Reads table of transient boundary profile data.
read_viewfactors(service, version, mode, path)	Reads view factors from a file.
reload_setup(service, version, mode, path)	Discards any changes in the current ANSYS Fluent in Workbench session and removes any corresponding data from the Solution cell.
replace_mesh(service, version, mode, path)	Replaces the mesh with a new one while preserving settings.
set_batch_options(service, version, mode, path)	Sets the batch options.
set_error_on_invalid_command(service, ...)	Set whether to abort journal replay on invalid command.
set_idle_timeout(service, version, mode, path)	Set the idle timeout.
set_maximum_simultaneous_files(service, ...)	Specify the maximum number of files, such as report files and profiles, that may be open or written simultaneously.
set_target_reference_frame_for_write_profiles(...)	Set reference frame options, which will be used for position transformation during writing of profiles.
set_tui_version(service, version, mode, path)	Set the version of the TUI commands.
show_configuration(service, version, mode, path)	.
single_precision_coordinates(service, ...)	Specifies whether the nodal coordinates should be written in single precision (rather than the default double precision).
solution_files(service, version, mode, path)	Enters the solution files menu.
start_journal(service, version, mode, path)	.
start_transcript(service, version, mode, path)	.
stop_journal(service, version, mode, path)	.
stop_macro(service, version, mode, path)	Stops recording input to a macro.
stop_transcript(service, version, mode, path)	.
sync_workbench(service, version, mode, path)	Directly updates Workbench with the most recent Fluent changes.
table_manager(service, version, mode, path)	Enters the table file manager menu.
transient_export(service, version, mode, path)	Enter the export menu.
write_boundary_mesh(service, version, mode, path)	Writes the boundary mesh to a file.
write_case(service, version, mode, path)	Write a case file.
write_case_data(service, version, mode, path)	Writes a case and a data file.
write_circumferential_averaged_profile(...)	Write surface data as a boundary profile file.
write_cleanup_script(service, version, mode, ...)	Writes the cleanup-script-file for ANSYS Fluent.
write_currently_defined_profiles(service, ...)	Write currently defined profiles.
write_data(service, version, mode, path)	Writes a data file.
write_fan_profile(service, version, mode, path)	Computes radial profiles for a fan zone and writes them to a profile file.
write_field_functions(service, version, ...)	Writes the currently defined custom field functions to a file.
write_flamelet(service, version, mode, path)	Writes a flamelet file.
write_gpu_restart(service, version, mode, path)	Write gpuapp restart case and data files.
write_injections(service, version, mode, path)	Writes out selected DPM injections to a file.
write_isat_table(service, version, mode, path)	Writes ISAT Table.
write_macros(service, version, mode, path)	Writes the currently defined macros to a file.
write_merge_profiles(service, version, mode, ...)	Writes a .csv file with the selected surfaces consolidated into one set of data points.
write_pdat(service, version, mode, path)	Enables / disables the attempt to save .pdat files.
write_pdf(service, version, mode, path)	Writes a pdf file.
write_profile(service, version, mode, path)	Writes surface data as a boundary profile file.
write_selected_defined_profiles(service, ...)	Set profile names, only these profile names which will be used during writing of *.csv profiles.
write_settings(service, version, mode, path)	Writes out current boundary conditions in use.

class async_optimize(service, version, mode, path)

Bases: TUIMethod

Chooses whether to optimize file I/O using scratch disks and asynchronous operations.

class binary_legacy_files(service, version, mode, path)

Bases: TUIMethod

.

class cff_files(service, version, mode, path)

Bases: TUIMethod

.

class close_without_save(service, version, mode, path)

Bases: TUIMethod

Exits ANSYS Fluent without saving data in Workbench. This command is only available when running ANSYS Fluent in Workbench.

class confirm_overwrite(service, version, mode, path)

Bases: TUIMethod

.

class convert_hanging_nodes_during_read(service, version, mode, path)

Bases: TUIMethod

.

class data_file_options(service, version, mode, path)

Bases: TUIMethod

Sets derived quantities to be written in data file.

class define_macro(service, version, mode, path)

Bases: TUIMethod

Saves input to a named macro.

class execute_macro(service, version, mode, path)

Bases: TUIMethod

Runs a previously defined macro.

class export_to_cfd_post(service, version, mode, path)

Bases: TUIMethod

Exports data files that are compatible with CFD-Post and EnSight (that is, .cdat and .cst files) and opens CFD-Post, if desired.

class load_act_tool(service, version, mode, path)

Bases: TUIMethod

Load ACT Start Page.

class read_case(service, version, mode, path)

Bases: TUIMethod

Read a case file.

class read_case_data(service, version, mode, path)

Bases: TUIMethod

Reads a case and a data file.

class read_case_info(service, version, mode, path)

Bases: TUIMethod

Read basic case info.

class read_case_settings(service, version, mode, path)

Bases: TUIMethod

Read a case file while skipping mesh elements.

class read_data(service, version, mode, path)

Bases: TUIMethod

Reads a data file.

class read_field_functions(service, version, mode, path)

Bases: TUIMethod

Reads custom field function definitions from a file.

class read_gpu_restart(service, version, mode, path)

Bases: TUIMethod

Read gpuapp restart case and data files.

class read_injections(service, version, mode, path)

Bases: TUIMethod

Reads all DPM injections from a file.

class read_isat_table(service, version, mode, path)

Bases: TUIMethod

Reads ISAT Table.

class read_journal(service, version, mode, path)

Bases: TUIMethod

Read a journal file.

class read_macros(service, version, mode, path)

Bases: TUIMethod

Reads macro definitions from a file.

class read_pdf(service, version, mode, path)

Bases: TUIMethod

Reads a PDF file.

class read_profile(service, version, mode, path)

Bases: TUIMethod

Reads boundary profile data.

class read_rays(service, version, mode, path)

Bases: TUIMethod

Reads a ray file.

class read_settings(service, version, mode, path)

Bases: TUIMethod

Reads and sets boundary conditions from a specified file.

class read_surface_clusters(service, version, mode, path)

Bases: TUIMethod

Reads surface clusters from a file.

class read_transient_table(service, version, mode, path)

Bases: TUIMethod

Reads table of transient boundary profile data.

class read_viewfactors(service, version, mode, path)

Bases: TUIMethod

Reads view factors from a file.

class reload_setup(service, version, mode, path)

Bases: TUIMethod

Discards any changes in the current ANSYS Fluent in Workbench session and removes any corresponding data from the Solution cell. This command is only available when running ANSYS Fluent in Workbench.

class replace_mesh(service, version, mode, path)

Bases: TUIMethod

Replaces the mesh with a new one while preserving settings.

class set_batch_options(service, version, mode, path)

Bases: TUIMethod

Sets the batch options.

class set_error_on_invalid_command(service, version, mode, path)

Bases: TUIMethod

Set whether to abort journal replay on invalid command.

class set_idle_timeout(service, version, mode, path)

Bases: TUIMethod

Set the idle timeout.

class set_maximum_simultaneous_files(service, version, mode, path)

Bases: TUIMethod

Specify the maximum number of files, such as report files and profiles, that may be open or written simultaneously. If the number of working files exceeds this limit, files may not be written or Fluent may close unexpectedly.

class set_target_reference_frame_for_write_profiles(service, version, mode, path)

Bases: TUIMethod

Set reference frame options, which will be used for position transformation during writing of profiles.

class set_tui_version(service, version, mode, path)

Bases: TUIMethod

Set the version of the TUI commands.

class show_configuration(service, version, mode, path)

Bases: TUIMethod

.

class single_precision_coordinates(service, version, mode, path)

Bases: TUIMethod

Specifies whether the nodal coordinates should be written in single precision (rather than the default double precision). This text command is only available in the single-precision version of ANSYS Fluent.

class start_journal(service, version, mode, path)

Bases: TUIMethod

.

class start_transcript(service, version, mode, path)

Bases: TUIMethod

.

class stop_journal(service, version, mode, path)

Bases: TUIMethod

.

class stop_macro(service, version, mode, path)

Bases: TUIMethod

Stops recording input to a macro.

class stop_transcript(service, version, mode, path)

Bases: TUIMethod

.

class sync_workbench(service, version, mode, path)

Bases: TUIMethod

Directly updates Workbench with the most recent Fluent changes. This command is only available when running ANSYS Fluent in Workbench.

class write_boundary_mesh(service, version, mode, path)

Bases: TUIMethod

Writes the boundary mesh to a file.

class write_case(service, version, mode, path)

Bases: TUIMethod

Write a case file.

class write_case_data(service, version, mode, path)

Bases: TUIMethod

Writes a case and a data file.

class write_circumferential_averaged_profile(service, version, mode, path)

Bases: TUIMethod

Write surface data as a boundary profile file. To use *.csv format specify filename with .csv suffix.

class write_cleanup_script(service, version, mode, path)

Bases: TUIMethod

Writes the cleanup-script-file for ANSYS Fluent.

class write_currently_defined_profiles(service, version, mode, path)

Bases: TUIMethod

Write currently defined profiles. To use *.csv format specify filename with .csv suffix.

class write_data(service, version, mode, path)

Bases: TUIMethod

Writes a data file.

class write_fan_profile(service, version, mode, path)

Bases: TUIMethod

Computes radial profiles for a fan zone and writes them to a profile file.

class write_field_functions(service, version, mode, path)

Bases: TUIMethod

Writes the currently defined custom field functions to a file.

class write_flamelet(service, version, mode, path)

Bases: TUIMethod

Writes a flamelet file.

class write_gpu_restart(service, version, mode, path)

Bases: TUIMethod

Write gpuapp restart case and data files.

class write_injections(service, version, mode, path)

Bases: TUIMethod

Writes out selected DPM injections to a file.

class write_isat_table(service, version, mode, path)

Bases: TUIMethod

Writes ISAT Table.

class write_macros(service, version, mode, path)

Bases: TUIMethod

Writes the currently defined macros to a file.

class write_merge_profiles(service, version, mode, path)

Bases: TUIMethod

Writes a .csv file with the selected surfaces consolidated into one set of data points.

class write_pdat(service, version, mode, path)

Bases: TUIMethod

Enables / disables the attempt to save .pdat files. Note that this text command is no longer supported.

class write_pdf(service, version, mode, path)

Bases: TUIMethod

Writes a pdf file.

class write_profile(service, version, mode, path)

Bases: TUIMethod

Writes surface data as a boundary profile file.

class write_selected_defined_profiles(service, version, mode, path)

Bases: TUIMethod

Set profile names, only these profile names which will be used during writing of *.csv profiles.

class write_settings(service, version, mode, path)

Bases: TUIMethod

Writes out current boundary conditions in use.