Chapter 5: file/

Note: File paths with spaces must be enclosed within quotation marks when provided as the input for a command. For example: file/read-case/"c:\path with space\example.cas".

file/async-optimize?

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

file/auto-save/

Enters the auto save menu.

file/auto-save/append-file-name-with: 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.
file/auto-save/case-frequency: Specifies the frequency (in iterations, time steps, or flow time) with which case files are saved.
file/auto-save/data-frequency: Specifies the frequency (in iterations, time steps, or flow time) with which data files are saved.
file/auto-save/max-files: Sets the maximum number of files. Once the maximum is reached, files will be erased as new files are written.
file/auto-save/overwrite-existing-files: Overwrites existing files when files are automatically saved.
file/auto-save/retain-most-recent-files: Sets autosave to retain the 5 most recent files.
file/auto-save/root-name: Specifies the root name for the files that are saved.
file/auto-save/save-data-file-every: Specifies the type and frequency of the data file to be saved.

file/binary-files?

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

Important: Common Fluids Format (CFF) Files are always saved in binary format (and therefore cannot be saved in ASCII format), so setting this command to 'no' has no effect on CFF files, only the legacy (.cas and .dat) format.

file/cff-files?

Specifies which format used to write mesh, case, and data files, and which format is prioritized when reading. Answering yes specifies that the Common Fluids Format (.msh.h5, .cas.h5, and .dat.h5) is used, whereas no specifies that the legacy format (.msh, .cas, and .dat) is used.

file/cffio-options/

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

file/cffio-options/compression-level

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

file/cffio-options/io-mode

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.

file/cffio-options/single-precision-data?

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

file/close-without-save?

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

file/confirm-overwrite?

Confirms attempts to overwrite existing files.

file/convert-hanging-nodes-during-read?

Enables/disables the automatic conversion of 3D cells adjacent to hanging nodes / edges to polyhedra when the file is read, and ensures that the adaption method is set to the polyhedral unstructured mesh adaption (PUMA) method. By default this text command is enabled.

file/data-file-options

Sets derived quantities to be written in data file.

file/define-macro

Saves input to a named macro.

file/em-mapping/

Enters the electromagnetic loss mapping menu.

Important: When Ansys Fluent is run under Workbench and a connection is detected between the Ansys Fluent and Ansys Maxwell applications, the em-mapping text command menu includes only the volumetric-energy-loss and surface-energy-loss commands. The maintain-loss-on-initialization and remove-loss-only commands are available when there is no connection between Ansys Fluent and Ansys Maxwell and Fluent has electromagnetic loss data; Fluent can receive this loss data through a connection or from a previously solved data file.

file/em-mapping/maintain-loss-on-initialization: Maintains the loss data provided by Maxwell even if solution is initialized.
file/em-mapping/remove-loss-only: Removes the loss data provided by Maxwell and keeps all other solution data.
file/em-mapping/surface-energy-loss: Maps the total surface loss (that is, heat source) from Maxwell to Ansys Fluent so that you can perform a thermal analysis. This option is only available when there is a connection detected between the Ansys Fluent and Maxwell applications.
file/em-mapping/volumetric-energy-loss: Maps the total volumetric loss (that is, heat source) from Maxwell to Ansys Fluent so that you can perform a thermal analysis. This option is only available when there is a connection detected between the Ansys Fluent and Maxwell applications.

file/execute-macro

Runs a previously defined macro.

file/export-to-cfd-post

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

file/export/

Exports case and data information.

file/export/abaqus

Writes an ABAQUS file.

file/export/ascii

Writes an ASCII file.

file/export/cdat-for-cfd-post-&-ensight

Writes data files that are compatible with CFD-Post and EnSight (that is, .cdat and .cst files).

file/export/cgns

Writes a CGNS file. You can specify whether data is exported on the full domain (default), on specific cell zones (volume-select), or on specific surfaces (surface-select).

file/export/common-fluids-format-post

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

file/export/custom-heat-flux

Writes a generic file for heat transfer.

file/export/dx

Writes an IBM Data Explorer format file.

file/export/ensight

Writes EnSight geometry, velocity, and scalar files.

file/export/ensight-dvs-surfaces

Writes an EnSight DVS file for the specified surfaces and quantities.

file/export/ensight-dvs-volume

Writes an EnSight DVS file for the specified volumes and quantities.

file/export/ensight-gold

Writes EnSight Gold geometry, velocity, and scalar files.

file/export/ensight-gold-parallel-surfaces

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

file/export/ensight-gold-parallel-volume

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

file/export/ensight-gold-transient

Writes EnSight Gold Transient geometry, velocity, and scalar files.

file/export/fast-mesh

Writes FAST/Plot3D unstructured mesh file.

file/export/fast-scalar

Writes FAST/Plot3D unstructured scalar function file.

file/export/fast-solution

Writes FAST/Plot3D unstructured solution file.

file/export/fast-velocity

Writes FAST/Plot3D unstructured vector function file.

file/export/fieldview

Writes FIELDVIEW case and data files.

file/export/fieldview-data

Writes FIELDVIEW case and data files.

file/export/fieldview-unstruct

Writes FIELDVIEW unstructured combined file.

file/export/fieldview-unstruct-mesh

Writes FIELDVIEW unstructured mesh-only file.

file/export/fieldview-unstruct-data

Writes FIELDVIEW unstructured results-only file.

file/export/fieldview-unstruct-surfaces

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

file/export/gambit

Writes GAMBIT neutral file.

file/export/icemcfd-for-icepak

Writes a binary ICEM CFD domain file.

file/export/mechanical-apdl-input

Writes a Mechanical APDL Input file.

file/export/nastran

Writes a NASTRAN file.

file/export/particle-history-data

Exports particle-history data.

file/export/settings/

Enters the menu controlling CGNS export settings.

file/export/settings/cgns-default-cellsize-changes: Enabled by default, this setting ensures the cellSize property is reported according to CGNS expectations when only the mesh is exported. Some third-party software, such as Tecplot, may require that the cellSize be reported differently. In such cases, disable this setting.
file/export/settings/cgns-familyname: Controls whether or not family names (FamilyName_t) are exported to CGNS.
file/export/settings/cgns-merge-ngons-to-single-ngon: Controls whether multiple CGNS NGON_n's are merged into a single NGON_n.
file/export/settings/cgns-mesh-type: Controls the type of mesh exported by CGNS. You can choose whether the mesh is mixed (default), its native format, or polyhedral (NGON_n + NFACE_n).
file/export/settings/cgns-polyhedral-cpu-threads: Controls the number of CPU cores that are used to export CGNS Polyhedral elements.
file/export/settings/cgns-separate-cellzones: Controls whether Fluent exports separate CGNS zone_t for each cell zone.
file/export/settings/set-cgns-export-filetype: Specifies whether the mesh is exported in the ADF or HDF5 file type.

file/export/system-coupling-definition-file-settings/

Enters the system coupling file (.scp) menu.

file/export/system-coupling-definition-file-settings/enable-automatic-creation-of-scp-file: enables/disables automatically writing a .scp every time a case file is written.
file/export/system-coupling-definition-file-settings/write-system-coupling-file: Writes a system coupling (.scp) file.

file/export/taitherm

Exports TAITherm file.

file/export/tecplot

Writes a Tecplot+3DV format file.

file/fsi/

Enters the fluid-structure interaction menu.

file/fsi/display-fsi-mesh: Displays the mesh for a fluid-structure interaction.
file/fsi/read-fsi-mesh: Reads an FEM mesh for one-way data mapping from Ansys Fluent.
file/fsi/write-fsi-mesh: Writes a fluid-structure interaction mesh file.

file/import/

Imports case and data information.

file/import/abaqus/

Imports an ABAQUS file.

file/import/abaqus/fil: Reads an ABAQUS .fil result file as a case file.
file/import/abaqus/input: Reads an ABAQUS input file as a case file.
file/import/abaqus/odb: Reads an ABAQUS odb file as a case file.

file/import/cfx/

Imports a CFX file.

file/import/cfx/definition: Reads a CFX definition file as a case file.
file/import/cfx/result: Reads a CFX definition file as a case file.

file/import/cgns/

Imports a CGNS file.

file/import/cgns/data: Reads data from CGNS file.
file/import/cgns/mesh: Imports a CGNS mesh file.
file/import/cgns/mesh-data: Imports a CGNS mesh file and data file.

file/import/chemkin-mechanism

Reads a CHEMKIN mechanism file.

file/import/chemkin-report-each-line?

Enables/disables reporting after reading each line.

file/import/ensight

Reads an EnSight file as a case file.

file/import/flamelet/

Imports a flamelet file.

file/import/flamelet/standard: Reads a standard format flamelet file.
file/import/flamelet/cfx-rif: Reads a CFX-RIF format flamelet file.

file/import/fmu-file/

Enters the import FMU file menu.

file/import/fmu-file/define-fmu: Links the FMU variables with the Fluent output parameters.
file/import/fmu-file/import-fmu: Imports an FMU file.
file/import/fmu-file/select-fmu-local: Allows you to select FMU local variables to be monitored during the calculation.
file/import/fmu-file/set-fmu-parameter: Allows you to select FMU parameter variables and change their values.

file/import/gambit

Imports a GAMBIT neutral file.

file/import/hypermesh

Reads a HYPERMESH file as a case file.

file/import/mechanical-apdl/

Imports a Mechanical APDL file.

file/import/mechanical-apdl/input: Reads a Mechanical APDL file as a case file.
file/import/mechanical-apdl/result: Reads a Mechanical APDL result file as a case file.

file/import/nastran/

Imports a NASTRAN file.

file/import/nastran/bulkdata: Reads a NASTRAN file as a case file.
file/import/nastran/output2: Reads a NASTRAN op2 file as a case file.

file/import/partition/

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

file/import/partition/metis: Reads and partitions an Ansys Fluent case file.
file/import/partition/metis-zone: Reads and partitions an Ansys Fluent case file.

file/import/plot3d/

Imports a PLOT3D file.

file/import/plot3d/mesh: Reads a PLOT3D file as a case file.

file/import/tecplot/

Enters the Tecplot menu.

file/import/tecplot/mesh: Reads a Tecplot binary file as a case file.

file/load-act-tool

Loads the Ansys ACT simulation customization tool.

file/interpolate/

Interpolates data to/from another grid.

file/interpolate/read-data: Reads and interpolates data.
file/interpolate/write-data: Writes data for interpolation.
file/interpolate/zone-selection: Defines a list of cell zone IDs. If specified, interpolation data will be read/written for these cell zones only.

file/read-case

Reads a case file.

file/read-case-data

Reads a case and a data file.

file/read-case-info

Prints a summary of the properties of a case file in the Common Fluids Format (with the .cas.h5 extension) in the console, which you can review prior to reading the file. The summary includes the Fluent version that last saved the case, case precision and dimension, and the total number of cells, faces, and nodes.

file/read-case-settings

Reads only the case settings of a mesh or case file in the Common Fluids Format (with the .msh.h5 or .cas.h5 extension, respectively), without any of the data associated with the mesh. When setting up a case file with a large cell count, this allows you to review and/or modify the settings without having to wait for the reading of the mesh, on a machine that does not have the memory needed for the mesh (such as a personal computer or laptop).

file/read-data

Reads a data file.

file/read-field-functions

Reads custom field function definitions from a file.

file/read-injections

Reads all DPM injections from a file.

file/read-isat-table

Reads ISAT Table.

file/read-journal

Reads command input from one or more files.

file/read-macros

Reads macro definitions from a file.

file/read-pdf

Reads a PDF file.

file/read-profile

Reads boundary profile data.

file/read-rays

Reads a ray file.

file/read-settings

Reads and sets boundary conditions from a specified file.

file/read-surface-clusters

Reads surface clusters from a file.

file/read-transient-table

Reads table of transient boundary profile data.

file/read-viewfactors

Reads view factors from a file.

file/reload-setup

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.

file/replace-mesh

Replaces the mesh with a new one while preserving settings.

file/set-batch-options

Sets the batch options.

file/set-error-on-invalid-command

Specifies whether to abort a journal replay on encountering an invalid command. By default, this option is enabled.

file/set-idle-timeout

Allows you to set an idle timeout so that an idle Ansys Fluent session will automatically save and close after the specified time.

file/set-target-reference-frame-for-write-profiles

Specifies which reference frame is used when you write a profile using the file/write-profile text command.

file/set-tui-version

Allows you to improve backwards compatibility for journal files. This command hides any new TUI prompts that are added at a future release of Ansys Fluent and reverts to the arguments of the release that you specify using the command (within two full releases of the current release). The command is automatically added to a journal file as soon as you start the recording.

file/show-configuration

Displays current release and version information.

file/single-precision-coordinates?

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.

file/solution-files/

Enters the solution files menu.

file/solution-files/delete-solution: Deletes solution files.
file/solution-files/load-solution: Loads a solution file.
file/solution-files/print-solution-files: Prints a list of available solution files.

file/start-journal

Starts recording all input in a file. Note that commands entered using paths from older versions of Fluent will be upgraded to their current path in the journal file.

file/start-transcript

Starts recording input and output in a file.

file/stop-journal

Stops recording input and closes journal file.

file/stop-macro

Stops recording input to a macro.

file/stop-transcript

Stops recording input and output and closes transcript file.

file/sync-workbench

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

file/table-manager

Enters the table file manager menu.

file/table-manager/delete: Deletes a table from local storage.
file/table-manager/list-matrix-data: Lists the data of a “matrix” type locally-stored table.
file/table-manager/list-properties: Lists the properties of a locally-stored table.
file/table-manager/list-tables: Lists all locally-stored tables.
file/table-manager/read-matrix-data-file: Imports a “matrix” type table from a file into local storage.
file/table-manager/read-rgp-file: Imports a set of Real Gas Property (RGP) tables from a file into local storage.
file/table-manager/rename: Renames a locally-stored table.
file/table-manager/store-in-case-file?: Sets the persistence mode for RGP tables (embedded in case file or rely on external file).

file/transient-export/

file/transient-export/abaqus

Writes an ABAQUS file.

file/transient-export/ascii

Writes an ASCII file.

file/transient-export/cdat-for-cfd-post-&-ensight

Writes data files that are compatible with CFD-Post and EnSight (that is, .cdat and .cst files).

file/transient-export/cgns

Writes a CGNS file.

file/transient-export/dx

Writes an IBM Data Explorer format file.

file/transient-export/ensight-gold-transient

Writes EnSight Gold geometry, velocity, and scalar files.

file/transient-export/ensight-gold-from-existing-files

Writes EnSight Gold files using Ansys Fluent case files.

file/transient-export/ensight-gold-parallel-surfaces

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

file/transient-export/ensight-gold-parallel-volume

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

file/transient-export/fast

Writes a FAST/Plot3D unstructured mesh velocity scalar file.

file/transient-export/fast-solution

Writes a FAST/Plot3D unstructured solution file.

file/transient-export/fieldview-unstruct

Writes a FIELDVIEW unstructured combined file.

file/transient-export/fieldview-unstruct-mesh

Writes a FIELDVIEW unstructured mesh only file.

file/transient-export/fieldview-unstruct-data

Writes a FIELDVIEW unstructured results only file.

file/transient-export/fieldview-unstruct-surfaces

Writes FIELDVIEW unstructured combined file for surfaces.

file/transient-export/mechanical-apdl-input

Writes a Mechanical APDL input file.

file/transient-export/nastran

Writes a NASTRAN file.

file/transient-export/taitherm

Writes a TAITherm file.

file/transient-export/particle-history-data

Sets up an automatic particle-history data export.

file/transient-export/edit

Edits transient exports.

file/transient-export/delete

Deletes transient exports.

file/transient-export/settings/

Enters the automatic export settings menu.

file/transient-export/settings/cfd-post-compatible: 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.

file/write-boundary-mesh

Writes the boundary mesh to a file.

file/write-case

Writes a case file.

file/write-case-data

Writes a case and a data file.

file/write-circumferential-averaged-profile

Writes a circumferential-averaged profile for an axial or radial turbomachine.

file/write-cleanup-script

Writes the cleanup-script-file for Ansys Fluent.

file/write-data

Writes a data file.

file/write-fan-profile

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

file/write-field-functions

Writes the currently defined custom field functions to a file.

file/write-flamelet

Writes a flamelet file.

file/write-injections

Writes out selected DPM injections to a file.

file/write-isat-table

Writes ISAT Table.

file/write-macros

Writes the currently defined macros to a file.

file/write-merge-profiles

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

file/write-pdat?

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

file/write-pdf

Writes a pdf file.

file/write-profile

Writes surface data as a boundary profile file.

file/write-selected-defined-profiles

Writes out the specified profiles that are defined in the current case.

file/write-settings

Writes out current boundary conditions in use.