pyvista.OpenFOAMReader

class OpenFOAMReader(*args, **kwargs)

OpenFOAM Reader for .foam files.

By default, pyvista enables all patch arrays. This is a deviation from the vtk default.

Wraps vtkOpenFOAMReader.

Methods

OpenFOAMReader.disable_all_patch_arrays()	Disable reading of all patch arrays.
OpenFOAMReader.disable_patch_array(name)	Disable reading of patch array.
OpenFOAMReader.enable_all_patch_arrays()	Enable reading of all patch arrays.
OpenFOAMReader.enable_patch_array(name)	Enable reading of patch array.
OpenFOAMReader.patch_array_status(name)	Return status of reading patch array.
OpenFOAMReader.set_active_time_point(time_point)	Set active time or iteration by index.
OpenFOAMReader.set_active_time_value(time_value)	Set active time or iteration value.
OpenFOAMReader.time_point_value(time_point)	Value of time point or iteration by index.

Attributes

OpenFOAMReader.active_time_value	Active time or iteration value.
OpenFOAMReader.all_patch_arrays_status	Status of reading all patch arrays.
OpenFOAMReader.cell_to_point_creation	Whether cell data is translated to point data when read.
OpenFOAMReader.decompose_polyhedra	Whether polyhedra are to be decomposed when read.
OpenFOAMReader.number_patch_arrays	Return number of patch arrays in dataset.
OpenFOAMReader.number_time_points	Return number of time points or iterations available to read.
OpenFOAMReader.patch_array_names	Names of patch arrays in a list.
OpenFOAMReader.skip_zero_time	Indicate whether or not to ignore the '/0' time directory.