data_file#

Reader for Fluent data files.

Example#

>>> from ansys.fluent.core import examples
>>> from ansys.fluent.core.filereader.data_file import DataFile

>>> data_file_name = examples.download_file("elbow1.dat.h5", "pyfluent/file_session", return_without_path=False)

>>> reader = DataFile(data_file_name=data_file_name) # Instantiate a DataFile class

Classes:

DataFile([data_file_name, ...])

Class to read a Fluent case file.

class ansys.fluent.core.filereader.data_file.DataFile(data_file_name=None, project_file_name=None, case_file_handle=None)#

Bases: object

Class to read a Fluent case file.

Methods

`case_file`	Returns the name of the associated case file in string format.
`get_face_variables`(phase_name)	Extracts face variables available for a particular phase.
`get_phases`()	Returns list of phases available.
`get_cell_variables`(phase_name)	Extracts cell variables available for a particular phase.
`get_face_scalar_field_data`(phase_name, ...)	Gets scalar field data for face.
`get_face_vector_field_data`(phase_name, ...)	Gets vector field data for face.

Methods:

`__init__`([data_file_name, ...])	__init__ method of CaseFile class.
`get_cell_variables`(phase_name)	Extracts cell variables available for a particular phase.
`get_face_scalar_field_data`(phase_name, ...)	Gets scalar field data for face.
`get_face_variables`(phase_name)	Extracts face variables available for a particular phase.
`get_face_vector_field_data`(phase_name, ...)	Gets vector field data for face.
`get_phases`()	Returns list of phases available.
`variables`()	Returns all associated data variables in form of a dictionary.

Attributes:

case_file

Returns the name of the associated case file in string format.

__init__(data_file_name=None, project_file_name=None, case_file_handle=None)#: __init__ method of CaseFile class.

property case_file: str#: Returns the name of the associated case file in string format.

get_cell_variables(phase_name)#

Extracts cell variables available for a particular phase.

Parameters:

phase_namestr: Name of the phase.

Returns:

List of cell variables.

get_face_scalar_field_data(phase_name, field_name, surface_id)#

Gets scalar field data for face.

Parameters:

phase_namestr: Name of the phase.
field_name: str: Name of the field
surface_idList[int]: List of surface IDs for scalar field data.

Returns:

Numpy array containing scalar field data for a particular phase, field and surface.

get_face_variables(phase_name)#

Extracts face variables available for a particular phase.

Parameters:

phase_namestr: Name of the phase.

Returns:

List of face variables.

get_face_vector_field_data(phase_name, surface_id)#

Gets vector field data for face.

Parameters:

phase_namestr: Name of the phase.
surface_idList[int]: List of surface IDs for vector field data.

Returns:

Numpy array containing scalar field data for a particular phase, field and surface.

get_phases()#: Returns list of phases available.

variables()#: Returns all associated data variables in form of a dictionary.