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.

Used In

Docstring Examples

• BaseReader.hide_progress (1 use)
• BaseReader.show_progress (1 use)
• OpenFOAMReader.all_patch_arrays_status (1 use)
• OpenFOAMReader.cell_to_point_creation (1 use)
• OpenFOAMReader.disable_all_patch_arrays (1 use)
• 7 more

  • OpenFOAMReader.disable_patch_array (1 use)
  • OpenFOAMReader.enable_all_patch_arrays (1 use)
  • OpenFOAMReader.enable_patch_array (1 use)
  • OpenFOAMReader.number_patch_arrays (1 use)
  • OpenFOAMReader.patch_array_names (1 use)
  • OpenFOAMReader.patch_array_status (1 use)
  • OpenFOAMReader.skip_zero_time (1 use)

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.

Inherited Attributes

PointCellDataSelection.all_cell_arrays_status	Return the status of all cell arrays.
PointCellDataSelection.all_point_arrays_status	Return the status of all point arrays.
PointCellDataSelection.cell_array_names	Return the list of all cell array names.
_FileIOBase.extension_patterns	Return mapping from regex pattern matching associated with this class.
_FileIOBase.extensions	Return the file extensions associated with this class.
PointCellDataSelection.number_cell_arrays	Return the number of cell arrays.
PointCellDataSelection.number_point_arrays	Return the number of point arrays.
BaseReader.path	Return or set the filename or directory of the reader.
PointCellDataSelection.point_array_names	Return the list of all point array names.
BaseReader.reader	Return the vtk Reader object.
TimeReader.time_values	All time or iteration values.

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.

Inherited Methods

PointCellDataSelection.cell_array_status	Get status of cell array with name.
PointCellDataSelection.disable_all_cell_arrays	Disable all cell arrays.
PointCellDataSelection.disable_all_point_arrays	Disable all point arrays.
PointCellDataSelection.disable_cell_array	Disable cell array with name.
PointCellDataSelection.disable_point_array	Disable point array with name.
PointCellDataSelection.enable_all_cell_arrays	Enable all cell arrays.
PointCellDataSelection.enable_all_point_arrays	Enable all point arrays.
PointCellDataSelection.enable_cell_array	Enable cell array with name.
PointCellDataSelection.enable_point_array	Enable point array with name.
BaseReader.hide_progress	Hide the progress bar when loading the file.
PointCellDataSelection.point_array_status	Get status of point array with name.
BaseReader.read	Read data in file.
BaseReader.show_progress	Show a progress bar when loading the file.