File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -664,12 +664,16 @@ def write_data_to_vtk(self,
664664 datasets : dict | None = None ,
665665 volume_normalization : bool | None = None ,
666666 curvilinear : bool = False ):
667- """Creates a VTK object of the mesh
667+ """Creates a VTK object of the mesh and writes it to a file.
668+
669+ Supported formats are legacy ASCII ``.vtk`` (requires the ``vtk``
670+ package) and ``.vtkhdf`` (requires only ``h5py``).
668671
669672 Parameters
670673 ----------
671- filename : str
672- Name of the VTK file to write.
674+ filename : str or PathLike
675+ Name of the VTK file to write. Use a ``.vtkhdf`` extension for
676+ the VTKHDF format or ``.vtk`` for the legacy ASCII format.
673677 datasets : dict
674678 Dictionary whose keys are the data labels and values are the data
675679 sets. 1D datasets are expected to be extracted directly from
You can’t perform that action at this time.
0 commit comments