CaseFile

The CaseFile class allows you to access Fluent case information without a live Fluent session. You command CaseFile objects to read your Fluent case files before you access the case information through the CaseFile methods.

Sample usage

This example shows how to command a CaseFile object to read a case file, and query its interface:

>>> from ansys.fluent.core import examples
>>> from ansys.fluent.core.filereader.case_file import CaseFile

>>> case_file_name = examples.download_file("Static_Mixer_Parameters.cas.h5", "pyfluent/static_mixer")
>>> reader = CaseFile(case_file_name=case_file_name)
>>> reader.precision()
2
>>> reader.num_dimensions()
3
>>> {p.name: p.value for p in reader.input_parameters()}
{'inlet1_vel': '1 [m/s]', 'inlet1_temp': '300 [K]', 'inlet2_vel': '1 [m/s]', 'inlet2_temp': '350 [K]'}
>>> {p.name: p.units for p in reader.output_parameters()}
{'outlet-temp-avg-op': 'K', 'outlet-vel-avg-op': 'm s^-1'}

Additional features

Along with basic functionality, the CaseFile class provides many additional features, including these:

• Supports multiple file formats The CaseFile class can read Fluent case files (CAS, CAS.HF, and CAS.GZ) in both text and binary formats.

• Takes a project path as an argument The CaseFile class has an option for taking a Fluent project path (FLPRJ) as an argument and locating the case file path:

  >>> reader = CaseFile(project_file_name="Dir1/Dir2/project.flprj")
  

• Reads ``rp_vars`` and ``config_vars`` variables The CaseFile class can provide the rp_vars and config_vars variables in Python data structures:

  >>> reader.rp_vars()
  >>> reader.config_vars()
  

• Extracts mesh data The CaseReader can be used to extract mesh data. This example shows how to command a CaseFile object to read a case file and extract and use the mesh data:

  >>> from ansys.fluent.core import examples
  >>> from ansys.fluent.core.filereader.case_file import CaseFile
  
  >>> case_file_name = examples.download_file("elbow1.cas.h5", "pyfluent/file_session")
  >>> reader = CaseFile(case_file_name=case_file_name)
  >>> reader.get_mesh().get_surface_ids()
  [3, 4, 5, 6, 7, 9]
  >>> reader.get_mesh().get_surface_names()
  ['wall',
   'symmetry',
   'pressure-outlet-7',
   'velocity-inlet-6',
   'velocity-inlet-5',
   'default-interior']
  >>> reader.get_mesh().get_surface_locs(3)
  [0, 3629]
  >>> reader.get_mesh().get_connectivity(3)
  array([   4,    3,    2, ...,  727,  694, 3809], dtype=uint32)
  >>> reader.get_mesh().get_vertices(3)
  array([ 0.        , -0.1016    ,  0.        , ...,  0.00620755,
   -0.19304685,  0.03033731])