download_cavity

download_cavity(load: bool = True) → MultiBlock | str

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:

outputpyvista.MultiBlock | str

DataSet or filename depending on load.

Examples

Download Python source code | Download Jupyter notebook

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

See Also

Cavity Dataset

See this dataset in the Dataset Gallery for more info.

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)
• 8 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)
  • POpenFOAMReader.case_type (1 use)

Gallery Examples

Plot OpenFOAM Data

Plot OpenFOAM Data

1 use