OpenFOAMReader.patch_array_status

OpenFOAMReader.patch_array_status(name)

Return status of reading patch array.

Parameters:

namestr

Which patch array to report status.

Returns:

bool

Whether the patch with the given name is to be read.

Examples

Download Python source code | Download Jupyter notebook

>>> import pyvista as pv
>>> from pyvista import examples
>>> filename = examples.download_cavity(load=False)
>>> reader = pv.OpenFOAMReader(filename)
>>> reader.enable_patch_array('patch/movingWall')
>>> reader.patch_array_status('patch/movingWall')
True