CompositeFilters.combine

CompositeFilters.combine#

CompositeFilters.combine(
*,
merge_points: bool = False,
tolerance: float = 0.0,
) → UnstructuredGrid[source]#

Combine all blocks into a single unstructured grid.

Parameters:
merge_pointsbool, default: False

Merge coincident points. The default differs from pyvista.merge(), which merges points by default.

Changed in version 0.50: Points of nested blocks are merged in a single pass, so a nonzero tolerance gives the same result as for the equivalent flat MultiBlock.

tolerancefloat, default: 0.0

The absolute tolerance to use to find coincident points when merge_points=True.

Returns:
pyvista.UnstructuredGrid

Combined blocks.

Examples#

Download Python source code | Download Jupyter notebook

Combine blocks within a multiblock without merging points.

>>> import pyvista as pv
>>> block = pv.MultiBlock(
...     [
...         pv.Cube(clean=False),
...         pv.Cube(center=(1, 0, 0), clean=False),
...     ]
... )
>>> merged = block.combine()
>>> merged.n_points
48

Combine blocks and merge points

>>> merged = block.combine(merge_points=True)
>>> merged.n_points
12