pyvista.examples.downloads.download_cgns_structured

pyvista.examples.downloads.download_cgns_structured#

download_cgns_structured(load=True)[source]#

Download the structured CGNS dataset mesh.

Originally downloaded from CFD General Notation System Example Files

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

Structured, 12 block, 3-D constricting channel, with example use of Family_t for BCs (ADF type). If load is False, then the path of the example CGNS file is returned.

Examples

Plot the example CGNS dataset.

>>> from pyvista import examples
>>> import pyvista as pv
>>> dataset = examples.download_cgns_structured()
>>> dataset[0].plot(scalars='Density')
../../../_images/pyvista-examples-downloads-download_cgns_structured-1_00_00.png

See also

Cgns Structured Dataset

See this dataset in the Dataset Gallery for more info.

Cgns Multi Dataset