file#

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

Bases: TUIMenu

Enter the file menu.

Methods:

async_optimize(*args, **kwargs)

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

binary_legacy_files(*args, **kwargs)

Indicate whether to write binary or text format case and data files.

cff_files(*args, **kwargs)

Indicate whether to write ANSYS common fluids format (CFF) files or legacy case and data files.

close_without_save(*args, **kwargs)

Exits ANSYS Fluent without saving data in Workbench.

confirm_overwrite(*args, **kwargs)

Indicate whether or not to confirm attempts to overwrite existing files.

data_file_options(*args, **kwargs)

Sets derived quantities to be written in data file.

define_macro(*args, **kwargs)

Saves input to a named macro.

execute_macro(*args, **kwargs)

Runs a previously defined macro.

export_to_cfd_post(*args, **kwargs)

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

load_act_tool(*args, **kwargs)

Load ACT Start Page.

read_case(*args, **kwargs)

Read a case file.

read_case_data(*args, **kwargs)

Reads a case and a data file.

read_case_info(*args, **kwargs)

Read basic case info.

read_case_settings(*args, **kwargs)

Read a case file while skipping mesh elements.

read_data(*args, **kwargs)

Reads a data file.

read_field_functions(*args, **kwargs)

Reads custom field function definitions from a file.

read_injections(*args, **kwargs)

Reads all DPM injections from a file.

read_isat_table(*args, **kwargs)

Reads ISAT Table.

read_journal(*args, **kwargs)

Read a journal file.

read_macros(*args, **kwargs)

Reads macro definitions from a file.

read_pdf(*args, **kwargs)

Reads a PDF file.

read_profile(*args, **kwargs)

Reads boundary profile data.

read_rays(*args, **kwargs)

Reads a ray file.

read_settings(*args, **kwargs)

Reads and sets boundary conditions from a specified file.

read_surface_clusters(*args, **kwargs)

Reads surface clusters from a file.

read_transient_table(*args, **kwargs)

Reads table of transient boundary profile data.

read_viewfactors(*args, **kwargs)

Reads view factors from a file.

reload_setup(*args, **kwargs)

Discards any changes in the current ANSYS Fluent in Workbench session and removes any corresponding data from the Solution cell.

replace_mesh(*args, **kwargs)

Replaces the mesh with a new one while preserving settings.

set_batch_options(*args, **kwargs)

Sets the batch options.

set_err_on_inval_cmd(*args, **kwargs)

Set whether to abort journal replay on invalid command.

set_idle_timeout(*args, **kwargs)

Set the idle timeout.

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(*args, **kwargs)

Set the version of the TUI commands.

show_configuration(*args, **kwargs)

Display current release and version information.

single_precision_coordinates(*args, **kwargs)

Specifies whether the nodal coordinates should be written in single precision (rather than the default double precision).

start_journal(*args, **kwargs)

Start recording all input in a file.

start_transcript(*args, **kwargs)

Start recording input and output in a file.

stop_journal(*args, **kwargs)

Stop recording input and close the journal file.

stop_macro(*args, **kwargs)

Stops recording input to a macro.

stop_transcript(*args, **kwargs)

Stop recording input and output and close the transcript file.

sync_workbench(*args, **kwargs)

Directly updates Workbench with the most recent Fluent changes.

write_boundary_mesh(*args, **kwargs)

Writes the boundary mesh to a file.

write_case(*args, **kwargs)

Write a case file.

write_case_data(*args, **kwargs)

Writes a case and a data file.

write_circumferential_averaged_profile(...)

Write surface data as a boundary profile file.

write_cleanup_script(*args, **kwargs)

Writes the cleanup-script-file for ANSYS Fluent.

write_currently_defined_profiles(*args, **kwargs)

Write currently defined profiles.

write_data(*args, **kwargs)

Writes a data file.

write_fan_profile(*args, **kwargs)

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

write_field_functions(*args, **kwargs)

Writes the currently defined custom field functions to a file.

write_flamelet(*args, **kwargs)

Writes a flamelet file.

write_injections(*args, **kwargs)

Writes out selected DPM injections to a file.

write_isat_table(*args, **kwargs)

Writes ISAT Table.

write_macros(*args, **kwargs)

Writes the currently defined macros to a file.

write_merge_profiles(*args, **kwargs)

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

write_pdat(*args, **kwargs)

Enables / disables the attempt to save .pdat files.

write_pdf(*args, **kwargs)

Writes a pdf file.

write_profile(*args, **kwargs)

Writes surface data as a boundary profile file.

write_selected_defined_profiles(*args, **kwargs)

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

write_settings(*args, **kwargs)

Writes out current boundary conditions in use.

Classes:

auto_save(path, service)

Enters the auto save menu.

cffio_options(path, service)

Enters the cffio options menu, which provides options for the I/O of case and data files in the Common Fluids Format (CFF).

em_mapping(path, service)

Enters the electromagnetic loss mapping menu.

export(path, service)

Enter the export menu.

fsi(path, service)

Enters the fluid-structure interaction menu.

import_(path, service)

Enter the import menu.

interpolate(path, service)

Interpolates data to/from another grid.

parametric_project(path, service)

Enter to open, save, archive parametric project.

project(path, service)

Enter to create new project, open project, save and archive project.

solution_files(path, service)

Enters the solution files menu.

table_manager(path, service)

Enters the table file manager menu.

transient_export(path, service)

Enter the export menu.
async_optimize(*args, **kwargs)#

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

class auto_save(path, service)#

Bases: TUIMenu

Enters the auto save menu.

Methods:

append_file_name_with(*args, **kwargs)

Sets the suffix for auto-saved files.

case_frequency(*args, **kwargs)

Specifies the frequency (in iterations, time steps, or flow time) with which case files are saved.

data_frequency(*args, **kwargs)

Specifies the frequency (in iterations, time steps, or flow time) with which data files are saved.

max_files(*args, **kwargs)

Sets the maximum number of files.

retain_most_recent_files(*args, **kwargs)

Sets autosave to retain the 5 most recent files.

root_name(*args, **kwargs)

Specifies the root name for the files that are saved.

save_data_file_every(*args, **kwargs)

Specifies the type and frequency of the data file to be saved.
append_file_name_with(*args, **kwargs)#

Sets the suffix for auto-saved files. The file name can be appended by flow-time, time-step value, or by user-specified flags in file name.

case_frequency(*args, **kwargs)#

Specifies the frequency (in iterations, time steps, or flow time) with which case files are saved.

data_frequency(*args, **kwargs)#

Specifies the frequency (in iterations, time steps, or flow time) with which data files are saved.

max_files(*args, **kwargs)#

Sets the maximum number of files. Once the maximum is reached, files will be erased as new files are written.

retain_most_recent_files(*args, **kwargs)#

Sets autosave to retain the 5 most recent files.

root_name(*args, **kwargs)#

Specifies the root name for the files that are saved.

save_data_file_every(*args, **kwargs)#

Specifies the type and frequency of the data file to be saved.

binary_legacy_files(*args, **kwargs)#

Indicate whether to write binary or text format case and data files.

cff_files(*args, **kwargs)#

Indicate whether to write ANSYS common fluids format (CFF) files or legacy case and data files.

class cffio_options(path, service)#

Bases: TUIMenu

Enters the cffio options menu, which provides options for the I/O of case and data files in the Common Fluids Format (CFF).

Methods:

compression_level(*args, **kwargs)

Sets the compression level for CFF files.

io_mode(*args, **kwargs)

Sets the I/O mode for writing CFF files.

single_precision_data(*args, **kwargs)

Specifies whether the double-precision solver saves single-precision data when writing CFF data files, in order to reduce the size of the files.
compression_level(*args, **kwargs)#

Sets the compression level for CFF files. The compression level can be set between 0 and 9 with 0 being least compression (fastest) and 9 being highest compression (slowest).

io_mode(*args, **kwargs)#

Sets the I/O mode for writing CFF files. 1. HOST: I/O is done serially by the host process. 2. NODE0: I/O is done serially by the node 0 process. 3. PARALLEL INDEPENDENT: I/O is done in parallel using the independent mode of MPI I/O. 4. PARALLEL COLLECTIVE: I/O is done in parallel using the collective mode of MPI I/O.

single_precision_data(*args, **kwargs)#

Specifies whether the double-precision solver saves single-precision data when writing CFF data files, in order to reduce the size of the files.

close_without_save(*args, **kwargs)#

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

confirm_overwrite(*args, **kwargs)#

Indicate whether or not to confirm attempts to overwrite existing files.

data_file_options(*args, **kwargs)#

Sets derived quantities to be written in data file.

define_macro(*args, **kwargs)#

Saves input to a named macro.

class em_mapping(path, service)#

Bases: TUIMenu

Enters the electromagnetic loss mapping menu.

Methods:

maintain_loss_on_initialization(*args, **kwargs)

Maintains the loss data provided by Maxwell even if solution is initialized.

remove_loss_only(*args, **kwargs)

Removes the loss data provided by Maxwell and keeps all other solution data.

surface_energy_source(*args, **kwargs)

Loss data provided by Ansoft will be assigned to Fluent for selected wall zones.

volumetric_energy_source(*args, **kwargs)

Loss data provided by Ansoft will be assigned to Fluent for selected cell zones.
maintain_loss_on_initialization(*args, **kwargs)#

Maintains the loss data provided by Maxwell even if solution is initialized.

remove_loss_only(*args, **kwargs)#

Removes the loss data provided by Maxwell and keeps all other solution data.

surface_energy_source(*args, **kwargs)#

Loss data provided by Ansoft will be assigned to Fluent for selected wall zones.

volumetric_energy_source(*args, **kwargs)#

Loss data provided by Ansoft will be assigned to Fluent for selected cell zones.

execute_macro(*args, **kwargs)#

Runs a previously defined macro.

class export(path, service)#

Bases: TUIMenu

Enter the export menu.

Methods:

abaqus(*args, **kwargs)

Writes an ABAQUS file.

ascii(*args, **kwargs)

Writes an ASCII file.

avs(*args, **kwargs)

Writes an AVS UCD file.

cdat_for_cfd_post__and__ensight(*args, **kwargs)

Write a CDAT for CFD-Post & EnSight file.

cgns(*args, **kwargs)

Write a CGNS file.

common_fluids_format_post(*args, **kwargs)

Writes common fluids format files (.cas.post and .dat.post) for mesh and data, respectively.

custom_heat_flux(*args, **kwargs)

Writes a generic file for heat transfer.

dx(*args, **kwargs)

Writes an IBM Data Explorer format file.

ensight(*args, **kwargs)

Writes EnSight geometry, velocity, and scalar files.

ensight_dvs_surfaces(*args, **kwargs)

Write post-processing data(geometry, velocity and scalars) for surfaces using EnSight Dynamic Visualization Store Interface.

ensight_dvs_volume(*args, **kwargs)

Write post-processing data(geometry, velocity and scalars) for cell zones and boundaries attached to them using EnSight Dynamic Visualization Store Interface.

ensight_gold(*args, **kwargs)

Writes EnSight Gold geometry, velocity, and scalar files.

ensight_gold_parallel_surfaces(*args, **kwargs)

Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for ANSYS Ensight Enterprise.

ensight_gold_parallel_volume(*args, **kwargs)

Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for ANSYS Ensight Enterprise.

fast_mesh(*args, **kwargs)

Writes FAST/Plot3D unstructured mesh file.

fast_scalar(*args, **kwargs)

Writes FAST/Plot3D unstructured scalar function file.

fast_solution(*args, **kwargs)

Writes FAST/Plot3D unstructured solution file.

fast_velocity(*args, **kwargs)

Writes FAST/Plot3D unstructured vector function file.

fieldview(*args, **kwargs)

Writes FIELDVIEW case and data files.

fieldview_data(*args, **kwargs)

Writes FIELDVIEW case and data files.

fieldview_unstruct(*args, **kwargs)

Writes FIELDVIEW unstructured combined file.

fieldview_unstruct_data(*args, **kwargs)

Writes FIELDVIEW unstructured results-only file.

fieldview_unstruct_mesh(*args, **kwargs)

Writes FIELDVIEW unstructured mesh-only file.

fieldview_unstruct_surfaces(*args, **kwargs)

Writes FIELDVIEW unstructured file for surfaces.

fieldview_xdb(*args, **kwargs)

Write a FieldView XDB format file.

gambit(*args, **kwargs)

Writes GAMBIT neutral file.

icemcfd_for_icepak(*args, **kwargs)

Writes a binary ICEM CFD domain file.

ideas(*args, **kwargs)

Writes an I-deas universal file.

mechanical_apdl(*args, **kwargs)

Write an Mechanical APDL file.

mechanical_apdl_input(*args, **kwargs)

Writes a Mechanical APDL Input file.

nastran(*args, **kwargs)

Write a NASTRAN file.

particle_history_data(*args, **kwargs)

Exports particle-history data.

patran_neutral(*args, **kwargs)

Writes a PATRAN neutral file.

patran_nodal(*args, **kwargs)

Writes a PATRAN nodal results file.

system_coupling_definition_file_settings(...)

Enters the system coupling file (.scp) menu.

taitherm(*args, **kwargs)

Exports TAITherm file.

tecplot(*args, **kwargs)

Writes a Tecplot+3DV format file.

Classes:

settings(path, service)

Enter the export settings menu.
abaqus(*args, **kwargs)#

Writes an ABAQUS file.

ascii(*args, **kwargs)#

Writes an ASCII file.

avs(*args, **kwargs)#

Writes an AVS UCD file.

cdat_for_cfd_post__and__ensight(*args, **kwargs)#

Write a CDAT for CFD-Post & EnSight file.

cgns(*args, **kwargs)#

Write a CGNS file.

common_fluids_format_post(*args, **kwargs)#

Writes common fluids format files (.cas.post and .dat.post) for mesh and data, respectively. These files are saved in the hierarchical data format.

custom_heat_flux(*args, **kwargs)#

Writes a generic file for heat transfer.

dx(*args, **kwargs)#

Writes an IBM Data Explorer format file.

ensight(*args, **kwargs)#

Writes EnSight geometry, velocity, and scalar files.

ensight_dvs_surfaces(*args, **kwargs)#

Write post-processing data(geometry, velocity and scalars) for surfaces using EnSight Dynamic Visualization Store Interface.

ensight_dvs_volume(*args, **kwargs)#

Write post-processing data(geometry, velocity and scalars) for cell zones and boundaries attached to them using EnSight Dynamic Visualization Store Interface.

ensight_gold(*args, **kwargs)#

Writes EnSight Gold geometry, velocity, and scalar files.

ensight_gold_parallel_surfaces(*args, **kwargs)#

Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for ANSYS Ensight Enterprise.

ensight_gold_parallel_volume(*args, **kwargs)#

Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for ANSYS Ensight Enterprise.

fast_mesh(*args, **kwargs)#

Writes FAST/Plot3D unstructured mesh file.

fast_scalar(*args, **kwargs)#

Writes FAST/Plot3D unstructured scalar function file.

fast_solution(*args, **kwargs)#

Writes FAST/Plot3D unstructured solution file.

fast_velocity(*args, **kwargs)#

Writes FAST/Plot3D unstructured vector function file.

fieldview(*args, **kwargs)#

Writes FIELDVIEW case and data files.

fieldview_data(*args, **kwargs)#

Writes FIELDVIEW case and data files.

fieldview_unstruct(*args, **kwargs)#

Writes FIELDVIEW unstructured combined file.

fieldview_unstruct_data(*args, **kwargs)#

Writes FIELDVIEW unstructured results-only file.

fieldview_unstruct_mesh(*args, **kwargs)#

Writes FIELDVIEW unstructured mesh-only file.

fieldview_unstruct_surfaces(*args, **kwargs)#

Writes FIELDVIEW unstructured file for surfaces. You are prompted to select either [1], [2] or [3] to write either mesh-only, results-only, or combined for surfaces (respectively).

fieldview_xdb(*args, **kwargs)#

Write a FieldView XDB format file.

gambit(*args, **kwargs)#

Writes GAMBIT neutral file.

icemcfd_for_icepak(*args, **kwargs)#

Writes a binary ICEM CFD domain file.

ideas(*args, **kwargs)#

Writes an I-deas universal file.

mechanical_apdl(*args, **kwargs)#

Write an Mechanical APDL file.

mechanical_apdl_input(*args, **kwargs)#

Writes a Mechanical APDL Input file.

nastran(*args, **kwargs)#

Write a NASTRAN file.

particle_history_data(*args, **kwargs)#

Exports particle-history data.

patran_neutral(*args, **kwargs)#

Writes a PATRAN neutral file.

patran_nodal(*args, **kwargs)#

Writes a PATRAN nodal results file.

class settings(path, service)#

Bases: TUIMenu

Enter the export settings menu.

Methods:

set_cgns_export_filetype(*args, **kwargs)

Select HDF5 or ADF as file format for CGNS.
set_cgns_export_filetype(*args, **kwargs)#

Select HDF5 or ADF as file format for CGNS.

system_coupling_definition_file_settings(*args, **kwargs)#

Enters the system coupling file (.scp) menu.

taitherm(*args, **kwargs)#

Exports TAITherm file.

tecplot(*args, **kwargs)#

Writes a Tecplot+3DV format file.

export_to_cfd_post(*args, **kwargs)#

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

class fsi(path, service)#

Bases: TUIMenu

Enters the fluid-structure interaction menu.

Methods:

conserve_force(*args, **kwargs)

Conserve the forces for linear line, tri and tet elements.

display_fsi_mesh(*args, **kwargs)

Displays the mesh for a fluid-structure interaction.

read_fsi_mesh(*args, **kwargs)

Reads an FEM mesh for one-way data mapping from ANSYS Fluent.

write_fsi_mesh(*args, **kwargs)

Writes a fluid-structure interaction mesh file.
conserve_force(*args, **kwargs)#

Conserve the forces for linear line, tri and tet elements.

display_fsi_mesh(*args, **kwargs)#

Displays the mesh for a fluid-structure interaction.

read_fsi_mesh(*args, **kwargs)#

Reads an FEM mesh for one-way data mapping from ANSYS Fluent.

write_fsi_mesh(*args, **kwargs)#

Writes a fluid-structure interaction mesh file.

class import_(path, service)#

Bases: TUIMenu

Enter the import menu.

Classes:

abaqus(path, service)

Imports an ABAQUS file.

cfx(path, service)

Imports a CFX file.

cgns(path, service)

Imports a CGNS file.

lstc(path, service)

Imports an LSTC file.

mechanical_apdl(path, service)

Imports a Mechanical APDL file.

nastran(path, service)

Imports a NASTRAN file.

partition(path, service)

Enters the partition menu to set conditions for partitioning an ANSYS Fluent case file during read.

patran(path, service)

Imports a PATRAN neutral file (zones defined by named components).

plot3d(path, service)

Imports a PLOT3D file.

tecplot(path, service)

Enters the Tecplot menu.

Methods:

chemkin_mechanism(*args, **kwargs)

Reads a CHEMKIN mechanism file.

chemkin_report_each_line(*args, **kwargs)

Enables/disables reporting after reading each line.

ensight(*args, **kwargs)

Reads an EnSight file as a case file.

fidap(*args, **kwargs)

Imports a FIDAP neutral file.

flamelet(*args, **kwargs)

Imports a flamelet file.

fluent4_case(*args, **kwargs)

Imports a formatted ANSYS Fluent 4 case file.

fmu_file(*args, **kwargs)

Enters the import FMU file menu.

gambit(*args, **kwargs)

Imports a GAMBIT neutral file.

hypermesh(*args, **kwargs)

Reads a HYPERMESH file as a case file.

ideas_universal(*args, **kwargs)

Imports an I-deas Universal file.

marc_post(*args, **kwargs)

Reads a MARC POST file as a case file.

prebfc_structured(*args, **kwargs)

Imports a formatted PreBFC structured mesh file.

ptc_mechanica(*args, **kwargs)

Reads a PTC Mechanica Design file as a case file.
class abaqus(path, service)#

Bases: TUIMenu

Imports an ABAQUS file.

Methods:

fil(*args, **kwargs)

Reads an ABAQUS .fil result file as a case file.

input(*args, **kwargs)

Reads an ABAQUS input file as a case file.

odb(*args, **kwargs)

Reads an ABAQUS odb file as a case file.
fil(*args, **kwargs)#

Reads an ABAQUS .fil result file as a case file.

input(*args, **kwargs)#

Reads an ABAQUS input file as a case file.

odb(*args, **kwargs)#

Reads an ABAQUS odb file as a case file.

class cfx(path, service)#

Bases: TUIMenu

Imports a CFX file.

Methods:

definition(*args, **kwargs)

Reads a CFX definition file as a case file.

result(*args, **kwargs)

Reads a CFX definition file as a case file.
definition(*args, **kwargs)#

Reads a CFX definition file as a case file.

result(*args, **kwargs)#

Reads a CFX definition file as a case file.

class cgns(path, service)#

Bases: TUIMenu

Imports a CGNS file.

Methods:

data(*args, **kwargs)

Reads data from CGNS file.

mesh(*args, **kwargs)

Imports a CGNS mesh file.

mesh_data(*args, **kwargs)

Imports a CGNS mesh file and data file.
data(*args, **kwargs)#

Reads data from CGNS file.

mesh(*args, **kwargs)#

Imports a CGNS mesh file.

mesh_data(*args, **kwargs)#

Imports a CGNS mesh file and data file.

chemkin_mechanism(*args, **kwargs)#

Reads a CHEMKIN mechanism file.

chemkin_report_each_line(*args, **kwargs)#

Enables/disables reporting after reading each line.

ensight(*args, **kwargs)#

Reads an EnSight file as a case file.

fidap(*args, **kwargs)#

Imports a FIDAP neutral file.

flamelet(*args, **kwargs)#

Imports a flamelet file.

fluent4_case(*args, **kwargs)#

Imports a formatted ANSYS Fluent 4 case file.

fmu_file(*args, **kwargs)#

Enters the import FMU file menu.

gambit(*args, **kwargs)#

Imports a GAMBIT neutral file.

hypermesh(*args, **kwargs)#

Reads a HYPERMESH file as a case file.

ideas_universal(*args, **kwargs)#

Imports an I-deas Universal file.

class lstc(path, service)#

Bases: TUIMenu

Imports an LSTC file.

Methods:

input(*args, **kwargs)

Reads an LSTC input file as a case file.

state(*args, **kwargs)

Reads an LSTC result file as a case file.
input(*args, **kwargs)#

Reads an LSTC input file as a case file.

state(*args, **kwargs)#

Reads an LSTC result file as a case file.

marc_post(*args, **kwargs)#

Reads a MARC POST file as a case file.

class mechanical_apdl(path, service)#

Bases: TUIMenu

Imports a Mechanical APDL file.

Methods:

input(*args, **kwargs)

Reads a Mechanical APDL file as a case file.

result(*args, **kwargs)

Reads a Mechanical APDL result file as a case file.
input(*args, **kwargs)#

Reads a Mechanical APDL file as a case file.

result(*args, **kwargs)#

Reads a Mechanical APDL result file as a case file.

class nastran(path, service)#

Bases: TUIMenu

Imports a NASTRAN file.

Methods:

bulkdata(*args, **kwargs)

Reads a NASTRAN file as a case file.

output2(*args, **kwargs)

Reads a NASTRAN op2 file as a case file.
bulkdata(*args, **kwargs)#

Reads a NASTRAN file as a case file.

output2(*args, **kwargs)#

Reads a NASTRAN op2 file as a case file.

class partition(path, service)#

Bases: TUIMenu

Enters the partition menu to set conditions for partitioning an ANSYS Fluent case file during read.

Methods:

metis(*args, **kwargs)

Reads and partitions an ANSYS Fluent case file.

metis_zone(*args, **kwargs)

Reads and partitions an ANSYS Fluent case file.
metis(*args, **kwargs)#

Reads and partitions an ANSYS Fluent case file.

metis_zone(*args, **kwargs)#

Reads and partitions an ANSYS Fluent case file.

class patran(path, service)#

Bases: TUIMenu

Imports a PATRAN neutral file (zones defined by named components).

Methods:

neutral(*args, **kwargs)

Reads a PATRAN Neutral file (zones defined by named components) as a case file.
neutral(*args, **kwargs)#

Reads a PATRAN Neutral file (zones defined by named components) as a case file.

class plot3d(path, service)#

Bases: TUIMenu

Imports a PLOT3D file.

Methods:

mesh(*args, **kwargs)

Reads a PLOT3D file as a case file.
mesh(*args, **kwargs)#

Reads a PLOT3D file as a case file.

prebfc_structured(*args, **kwargs)#

Imports a formatted PreBFC structured mesh file.

ptc_mechanica(*args, **kwargs)#

Reads a PTC Mechanica Design file as a case file.

class tecplot(path, service)#

Bases: TUIMenu

Enters the Tecplot menu.

Methods:

mesh(*args, **kwargs)

Reads a Tecplot binary file as a case file.
mesh(*args, **kwargs)#

Reads a Tecplot binary file as a case file.

class interpolate(path, service)#

Bases: TUIMenu

Interpolates data to/from another grid.

Methods:

read_data(*args, **kwargs)

Reads and interpolates data.

write_data(*args, **kwargs)

Writes data for interpolation.

zone_selection(*args, **kwargs)

Defines a list of cell zone IDs.
read_data(*args, **kwargs)#

Reads and interpolates data.

write_data(*args, **kwargs)#

Writes data for interpolation.

zone_selection(*args, **kwargs)#

Defines a list of cell zone IDs. If specified, interpolation data will be read/written for these cell zones only.

load_act_tool(*args, **kwargs)#

Load ACT Start Page.

class parametric_project(path, service)#

Bases: TUIMenu

Enter to open, save, archive parametric project.

Methods:

archive(*args, **kwargs)

Archive Project.

open(*args, **kwargs)

Open project.

save(*args, **kwargs)

Save Project.

save_a_copy(*args, **kwargs)

Save a Copy.

save_as(*args, **kwargs)

Save As Project.
archive(*args, **kwargs)#

Archive Project.

open(*args, **kwargs)#

Open project.

save(*args, **kwargs)#

Save Project.

save_a_copy(*args, **kwargs)#

Save a Copy.

save_as(*args, **kwargs)#

Save As Project.

class project(path, service)#

Bases: TUIMenu

Enter to create new project, open project, save and archive project.

Methods:

archive(*args, **kwargs)

Archive Project.

new(*args, **kwargs)

Create New Project.

open(*args, **kwargs)

Open project.

save(*args, **kwargs)

Save Project.

save_as(*args, **kwargs)

Save As Project.

save_as_copy(*args, **kwargs)

Save As Copy.
archive(*args, **kwargs)#

Archive Project.

new(*args, **kwargs)#

Create New Project.

open(*args, **kwargs)#

Open project.

save(*args, **kwargs)#

Save Project.

save_as(*args, **kwargs)#

Save As Project.

save_as_copy(*args, **kwargs)#

Save As Copy.

read_case(*args, **kwargs)#

Read a case file.

read_case_data(*args, **kwargs)#

Reads a case and a data file.

read_case_info(*args, **kwargs)#

Read basic case info.

read_case_settings(*args, **kwargs)#

Read a case file while skipping mesh elements.

read_data(*args, **kwargs)#

Reads a data file.

read_field_functions(*args, **kwargs)#

Reads custom field function definitions from a file.

read_injections(*args, **kwargs)#

Reads all DPM injections from a file.

read_isat_table(*args, **kwargs)#

Reads ISAT Table.

read_journal(*args, **kwargs)#

Read a journal file.

read_macros(*args, **kwargs)#

Reads macro definitions from a file.

read_pdf(*args, **kwargs)#

Reads a PDF file.

read_profile(*args, **kwargs)#

Reads boundary profile data.

read_rays(*args, **kwargs)#

Reads a ray file.

read_settings(*args, **kwargs)#

Reads and sets boundary conditions from a specified file.

read_surface_clusters(*args, **kwargs)#

Reads surface clusters from a file.

read_transient_table(*args, **kwargs)#

Reads table of transient boundary profile data.

read_viewfactors(*args, **kwargs)#

Reads view factors from a file.

reload_setup(*args, **kwargs)#

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.

replace_mesh(*args, **kwargs)#

Replaces the mesh with a new one while preserving settings.

set_batch_options(*args, **kwargs)#

Sets the batch options.

set_err_on_inval_cmd(*args, **kwargs)#

Set whether to abort journal replay on invalid command.

set_idle_timeout(*args, **kwargs)#

Set the idle timeout.

set_target_reference_frame_for_write_profiles(*args, **kwargs)#

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

set_tui_version(*args, **kwargs)#

Set the version of the TUI commands.

show_configuration(*args, **kwargs)#

Display current release and version information.

single_precision_coordinates(*args, **kwargs)#

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 solution_files(path, service)#

Bases: TUIMenu

Enters the solution files menu.

Methods:

delete_solution(*args, **kwargs)

Deletes solution files.

load_solution(*args, **kwargs)

Loads a solution file.

print_solution_files(*args, **kwargs)

Prints a list of available solution files.
delete_solution(*args, **kwargs)#

Deletes solution files.

load_solution(*args, **kwargs)#

Loads a solution file.

print_solution_files(*args, **kwargs)#

Prints a list of available solution files.

start_journal(*args, **kwargs)#

Start recording all input in a file.

start_transcript(*args, **kwargs)#

Start recording input and output in a file.

stop_journal(*args, **kwargs)#

Stop recording input and close the journal file.

stop_macro(*args, **kwargs)#

Stops recording input to a macro.

stop_transcript(*args, **kwargs)#

Stop recording input and output and close the transcript file.

sync_workbench(*args, **kwargs)#

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

class table_manager(path, service)#

Bases: TUIMenu

Enters the table file manager menu.

Methods:

delete(*args, **kwargs)

Deletes a table from local storage.

list_matrix_data(*args, **kwargs)

Lists the data of a “matrix” type locally-stored table.

list_properties(*args, **kwargs)

Lists the properties of a locally-stored table.

list_tables(*args, **kwargs)

Lists all locally-stored tables.

read_matrix_data_file(*args, **kwargs)

Imports a “matrix” type table from a file into local storage.

read_rgp_file(*args, **kwargs)

Imports a set of Real Gas Property (RGP) tables from a file into local storage.

rename(*args, **kwargs)

Renames a locally-stored table.

store_in_case_file(*args, **kwargs)

Sets the persistence mode for RGP tables (embedded in case file or rely on external file).
delete(*args, **kwargs)#

Deletes a table from local storage.

list_matrix_data(*args, **kwargs)#

Lists the data of a “matrix” type locally-stored table.

list_properties(*args, **kwargs)#

Lists the properties of a locally-stored table.

list_tables(*args, **kwargs)#

Lists all locally-stored tables.

read_matrix_data_file(*args, **kwargs)#

Imports a “matrix” type table from a file into local storage.

read_rgp_file(*args, **kwargs)#

Imports a set of Real Gas Property (RGP) tables from a file into local storage.

rename(*args, **kwargs)#

Renames a locally-stored table.

store_in_case_file(*args, **kwargs)#

Sets the persistence mode for RGP tables (embedded in case file or rely on external file).

class transient_export(path, service)#

Bases: TUIMenu

Enter the export menu.

Methods:

abaqus(*args, **kwargs)

Writes an ABAQUS file.

ascii(*args, **kwargs)

Writes an ASCII file.

avs(*args, **kwargs)

Writes an AVS UCD file.

cdat_for_cfd_post__and__ensight(*args, **kwargs)

Write a CDAT for CFD-Post & EnSight file.

cgns(*args, **kwargs)

Writes a CGNS file.

common_fluids_format_post(*args, **kwargs)

Write an CFF Post-Only file.

delete(*args, **kwargs)

Deletes transient exports.

dx(*args, **kwargs)

Writes an IBM Data Explorer format file.

edit(*args, **kwargs)

Edits transient exports.

ensight_dvs_surfaces(*args, **kwargs)

Write post-processing data(geometry, velocity and scalars) for surfaces using EnSight Dynamic Visualization Store Interface.

ensight_dvs_volume(*args, **kwargs)

Write post-processing data(geometry, velocity and scalars) for cell zones and boundaries attached to them using EnSight Dynamic Visualization Store Interface.

ensight_gold_from_existing_files(*args, **kwargs)

Writes EnSight Gold files using ANSYS Fluent case files.

ensight_gold_parallel_surfaces(*args, **kwargs)

Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for ANSYS Ensight Enterprise.

ensight_gold_parallel_volume(*args, **kwargs)

Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for ANSYS Ensight Enterprise.

ensight_gold_transient(*args, **kwargs)

Writes EnSight Gold geometry, velocity, and scalar files.

fast(*args, **kwargs)

Writes a FAST/Plot3D unstructured mesh velocity scalar file.

fast_solution(*args, **kwargs)

Writes a FAST/Plot3D unstructured solution file.

fieldview_unstruct(*args, **kwargs)

Writes a FIELDVIEW unstructured combined file.

fieldview_unstruct_data(*args, **kwargs)

Writes a FIELDVIEW unstructured results only file.

fieldview_unstruct_mesh(*args, **kwargs)

Writes a FIELDVIEW unstructured mesh only file.

fieldview_unstruct_surfaces(*args, **kwargs)

Writes FIELDVIEW unstructured combined file for surfaces.

fieldview_xdb(*args, **kwargs)

Write a FieldView XDB format file.

ideas(*args, **kwargs)

Writes an I-deas universal file.

mechanical_apdl_input(*args, **kwargs)

Writes a Mechanical APDL input file.

nastran(*args, **kwargs)

Writes a NASTRAN file.

particle_history_data(*args, **kwargs)

Sets up an automatic particle-history data export.

patran_neutral(*args, **kwargs)

Writes a PATRAN neutral file.

taitherm(*args, **kwargs)

Writes a TAITherm file.

tecplot(*args, **kwargs)

Write a Tecplot+3DV format file.

Classes:

settings(path, service)

Enters the automatic export settings menu.
abaqus(*args, **kwargs)#

Writes an ABAQUS file.

ascii(*args, **kwargs)#

Writes an ASCII file.

avs(*args, **kwargs)#

Writes an AVS UCD file.

cdat_for_cfd_post__and__ensight(*args, **kwargs)#

Write a CDAT for CFD-Post & EnSight file.

cgns(*args, **kwargs)#

Writes a CGNS file.

common_fluids_format_post(*args, **kwargs)#

Write an CFF Post-Only file.

delete(*args, **kwargs)#

Deletes transient exports.

dx(*args, **kwargs)#

Writes an IBM Data Explorer format file.

edit(*args, **kwargs)#

Edits transient exports.

ensight_dvs_surfaces(*args, **kwargs)#

Write post-processing data(geometry, velocity and scalars) for surfaces using EnSight Dynamic Visualization Store Interface.

ensight_dvs_volume(*args, **kwargs)#

Write post-processing data(geometry, velocity and scalars) for cell zones and boundaries attached to them using EnSight Dynamic Visualization Store Interface.

ensight_gold_from_existing_files(*args, **kwargs)#

Writes EnSight Gold files using ANSYS Fluent case files.

ensight_gold_parallel_surfaces(*args, **kwargs)#

Writes EnSight Gold geometry, velocity, and scalar files for surfaces in a parallel format suitable for ANSYS Ensight Enterprise.

ensight_gold_parallel_volume(*args, **kwargs)#

Writes EnSight Gold geometry, velocity, and scalar files for cell zones in a parallel format suitable for ANSYS Ensight Enterprise.

ensight_gold_transient(*args, **kwargs)#

Writes EnSight Gold geometry, velocity, and scalar files.

fast(*args, **kwargs)#

Writes a FAST/Plot3D unstructured mesh velocity scalar file.

fast_solution(*args, **kwargs)#

Writes a FAST/Plot3D unstructured solution file.

fieldview_unstruct(*args, **kwargs)#

Writes a FIELDVIEW unstructured combined file.

fieldview_unstruct_data(*args, **kwargs)#

Writes a FIELDVIEW unstructured results only file.

fieldview_unstruct_mesh(*args, **kwargs)#

Writes a FIELDVIEW unstructured mesh only file.

fieldview_unstruct_surfaces(*args, **kwargs)#

Writes FIELDVIEW unstructured combined file for surfaces.

fieldview_xdb(*args, **kwargs)#

Write a FieldView XDB format file.

ideas(*args, **kwargs)#

Writes an I-deas universal file.

mechanical_apdl_input(*args, **kwargs)#

Writes a Mechanical APDL input file.

nastran(*args, **kwargs)#

Writes a NASTRAN file.

particle_history_data(*args, **kwargs)#

Sets up an automatic particle-history data export.

patran_neutral(*args, **kwargs)#

Writes a PATRAN neutral file.

class settings(path, service)#

Bases: TUIMenu

Enters the automatic export settings menu.

Methods:

cfd_post_compatible(*args, **kwargs)

Specifies when case files are written with the .cdat and .cst files exported for Ansys CFD-Post.
cfd_post_compatible(*args, **kwargs)#

Specifies when case files are written with the .cdat and .cst files exported for Ansys CFD-Post. Note that this setting is ignored if the Write Case File Every Time option is enabled in the Automatic Export dialog box, which is always the case starting in Release 2021 R1.

taitherm(*args, **kwargs)#

Writes a TAITherm file.

tecplot(*args, **kwargs)#

Write a Tecplot+3DV format file.

write_boundary_mesh(*args, **kwargs)#

Writes the boundary mesh to a file.

write_case(*args, **kwargs)#

Write a case file.

write_case_data(*args, **kwargs)#

Writes a case and a data file.

write_circumferential_averaged_profile(*args, **kwargs)#

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

write_cleanup_script(*args, **kwargs)#

Writes the cleanup-script-file for ANSYS Fluent.

write_currently_defined_profiles(*args, **kwargs)#

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

write_data(*args, **kwargs)#

Writes a data file.

write_fan_profile(*args, **kwargs)#

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

write_field_functions(*args, **kwargs)#

Writes the currently defined custom field functions to a file.

write_flamelet(*args, **kwargs)#

Writes a flamelet file.

write_injections(*args, **kwargs)#

Writes out selected DPM injections to a file.

write_isat_table(*args, **kwargs)#

Writes ISAT Table.

write_macros(*args, **kwargs)#

Writes the currently defined macros to a file.

write_merge_profiles(*args, **kwargs)#

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

write_pdat(*args, **kwargs)#

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

write_pdf(*args, **kwargs)#

Writes a pdf file.

write_profile(*args, **kwargs)#

Writes surface data as a boundary profile file.

write_selected_defined_profiles(*args, **kwargs)#

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

write_settings(*args, **kwargs)#

Writes out current boundary conditions in use.