finam_vtk.read_vtk_grid#

finam_vtk.read_vtk_grid(path, remove_low_dim_cells=True, minimal_spatial_dim=True, **kwargs)[source]#

Read a finam grid from a VTK file.

Parameters:

  • path (pathlike) – Path to the vtk file.

  • remove_low_dim_cells (bool, optional) – Whether to remove lower dimension cells (like vertices or edges), by default True

  • minimal_spatial_dim (bool, optional) – Force grid to have minimal dimension (e.g. 2D grids are defined as 3D in vtk), by default True

  • **kwargs – Keyword arguments forwarded to the finam Grid class used.

Returns:

The resulting finam grid.

Return type:

finam.Grid