pyvista.examples.downloads.download_cavity#

download_cavity(load=True)[source]#

Download cavity OpenFOAM example.

Retrieved from Kitware VTK Data.

Parameters:
loadbool, default: True

Load the dataset after downloading it when True. Set this to False and only the filename will be returned.

Returns:
pyvista.MultiBlock | str

DataSet or filename depending on load.

Examples

>>> from pyvista import examples
>>> dataset = examples.download_cavity()

See Plot OpenFOAM data for a full example using this dataset.