pyvista.POpenFOAMReader#

class POpenFOAMReader(*args, **kwargs)[source]#

Parallel OpenFOAM Reader for .foam files.

Can read parallel-decomposed mesh information and time dependent data. This reader can be used for serial generated data, parallel reconstructed data, and decomposed data.

Methods

POpenFOAMReader.cell_array_status(name)

Get status of cell array with name.

POpenFOAMReader.disable_all_cell_arrays()

Disable all cell arrays.

POpenFOAMReader.disable_all_patch_arrays()

Disable reading of all patch arrays.

POpenFOAMReader.disable_all_point_arrays()

Disable all point arrays.

POpenFOAMReader.disable_cell_array(name)

Disable cell array with name.

POpenFOAMReader.disable_patch_array(name)

Disable reading of patch array.

POpenFOAMReader.disable_point_array(name)

Disable point array with name.

POpenFOAMReader.enable_all_cell_arrays()

Enable all cell arrays.

POpenFOAMReader.enable_all_patch_arrays()

Enable reading of all patch arrays.

POpenFOAMReader.enable_all_point_arrays()

Enable all point arrays.

POpenFOAMReader.enable_cell_array(name)

Enable cell array with name.

POpenFOAMReader.enable_patch_array(name)

Enable reading of patch array.

POpenFOAMReader.enable_point_array(name)

Enable point array with name.

POpenFOAMReader.hide_progress()

Hide the progress bar when loading the file.

POpenFOAMReader.patch_array_status(name)

Return status of reading patch array.

POpenFOAMReader.point_array_status(name)

Get status of point array with name.

POpenFOAMReader.read()

Read data in file.

POpenFOAMReader.set_active_time_point(time_point)

Set active time or iteration by index.

POpenFOAMReader.set_active_time_value(time_value)

Set active time or iteration value.

POpenFOAMReader.show_progress([msg])

Show a progress bar when loading the file.

POpenFOAMReader.time_point_value(time_point)

Value of time point or iteration by index.

Attributes

POpenFOAMReader.active_time_value

Active time or iteration value.

POpenFOAMReader.all_cell_arrays_status

Return the status of all cell arrays.

POpenFOAMReader.all_patch_arrays_status

Status of reading all patch arrays.

POpenFOAMReader.all_point_arrays_status

Return the status of all point arrays.

POpenFOAMReader.case_type

Indicate whether decomposed mesh or reconstructed mesh should be read.

POpenFOAMReader.cell_array_names

Return the list of all cell array names.

POpenFOAMReader.cell_to_point_creation

Whether cell data is translated to point data when read.

POpenFOAMReader.decompose_polyhedra

Whether polyhedra are to be decomposed when read.

POpenFOAMReader.number_cell_arrays

Return the number of cell arrays.

POpenFOAMReader.number_patch_arrays

Return number of patch arrays in dataset.

POpenFOAMReader.number_point_arrays

Return the number of point arrays.

POpenFOAMReader.number_time_points

Return number of time points or iterations available to read.

POpenFOAMReader.patch_array_names

Names of patch arrays in a list.

POpenFOAMReader.path

Return or set the filename or directory of the reader.

POpenFOAMReader.point_array_names

Return the list of all point array names.

POpenFOAMReader.reader

Return the vtk Reader object.

POpenFOAMReader.skip_zero_time

Indicate whether or not to ignore the '/0' time directory.

POpenFOAMReader.time_values

All time or iteration values.