POpenFOAMReader

class POpenFOAMReader(*args, **kwargs)

Parallel OpenFOAM Reader for .foam files.

Wraps vtkPOpenFOAMReader.

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.

Used In

Docstring Examples

• POpenFOAMReader.case_type (1 use)

Gallery Examples

Plot OpenFOAM Data

Plot OpenFOAM Data

1 use

Inheritance

Inherited members are documented on OpenFOAMReader, BaseReader, _FileIOBase, PointCellDataSelection, TimeReader.

See them all under Inherited Attributes and Inherited Methods.

Attributes

POpenFOAMReader.case_type

Indicate whether decomposed mesh or reconstructed mesh should be read.

Inherited Attributes

OpenFOAMReader.active_time_value	Active time or iteration value.
PointCellDataSelection.all_cell_arrays_status	Return the status of all cell arrays.
OpenFOAMReader.all_patch_arrays_status	Status of reading all patch 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.
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.
_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.
OpenFOAMReader.number_patch_arrays	Return number of patch arrays in dataset.
PointCellDataSelection.number_point_arrays	Return the number of point arrays.
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.
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.
OpenFOAMReader.skip_zero_time	Indicate whether or not to ignore the ‘/0’ time directory.
TimeReader.time_values	All time or iteration values.

Inherited Methods

PointCellDataSelection.cell_array_status	Get status of cell array with name.
PointCellDataSelection.disable_all_cell_arrays	Disable all cell arrays.
OpenFOAMReader.disable_all_patch_arrays	Disable reading of all patch arrays.
PointCellDataSelection.disable_all_point_arrays	Disable all point arrays.
PointCellDataSelection.disable_cell_array	Disable cell array with name.
OpenFOAMReader.disable_patch_array	Disable reading of patch array.
PointCellDataSelection.disable_point_array	Disable point array with name.
PointCellDataSelection.enable_all_cell_arrays	Enable all cell arrays.
OpenFOAMReader.enable_all_patch_arrays	Enable reading of all patch arrays.
PointCellDataSelection.enable_all_point_arrays	Enable all point arrays.
PointCellDataSelection.enable_cell_array	Enable cell array with name.
OpenFOAMReader.enable_patch_array	Enable reading of patch array.
PointCellDataSelection.enable_point_array	Enable point array with name.
BaseReader.hide_progress	Hide the progress bar when loading the file.
OpenFOAMReader.patch_array_status	Return status of reading patch array.
PointCellDataSelection.point_array_status	Get status of point array with name.
BaseReader.read	Read data in file.
OpenFOAMReader.set_active_time_point	Set active time or iteration by index.
OpenFOAMReader.set_active_time_value	Set active time or iteration value.
BaseReader.show_progress	Show a progress bar when loading the file.
OpenFOAMReader.time_point_value	Value of time point or iteration by index.